debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-24 20:08:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/emacs/notmuch-show.el

2733 lines
102 KiB
EmacsLisp
Raw Permalink Normal View History

emacs: use lexical-bindings in all libraries Doing so causes many new compile warnings. Some of these warnings concern genuine changes in behavior that have to be addressed right away. Many other warnings are due to unused variables. Nothing has changed here, except that the byte-compiler can now detect these pre-existing and harmless issues. We delay addressing these issues so that we can focus on the important ones here. A third group of warnings concern arguments that are not actually used inside the function but which cannot be removed because the functions signature is dictated by some outside convention. Silencing these warning is also delayed until subsequent commits.
2021-01-10 15:00:47 +01:00
;;; notmuch-show.el --- displaying notmuch forests -*- lexical-binding: t -*-
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
;;
;; Copyright © Carl Worth
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; Copyright © David Edmondson
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
;;
;; This file is part of Notmuch.
;;
;; Notmuch 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.
;;
;; Notmuch 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
Use https instead of http where possible Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-02 18:26:14 +02:00
;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
;;
;; Authors: Carl Worth <cworth@cworth.org>
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; David Edmondson <dme@dme.org>
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Fix packaging Refer to (info "(elisp) Library Headers") for package conventions.
2016-04-13 09:58:47 +02:00
;;; Code:
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(require 'mm-view)
(require 'message)
emacs: Use `mm-display-part' when possible For parts that the mm-decode/mm-view functions can inline and we have the content, use `mm-display-part' to insert the part in the buffer.
2010-03-23 12:54:05 +01:00
(require 'mm-decode)
emacs: Use mailcap.el to guess the type of application/octet-stream parts Use the mailcap functionality to guess a MIME type for attachments of type application/octet-stream and, presuming successful, feed the attachment back into the display code with the determine type. This is mostly useless at the moment, as the JSON output from notmuch does not include the content of application/octet-stream parts, so they cannot be displayed even if the guess is a good one.
2010-03-23 12:54:05 +01:00
(require 'mailcap)
emacs: Render text/x-vcalendar parts. Use code from icalendar.el to convert text/x-vcalendar parts to something suitable for use with the Emacs diary. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-12 10:07:49 +02:00
(require 'icalendar)
emacs: Turn id:"<message-id>" elements into buttons for notmuch searches This fixes the minor annoyance that message ids were parsed as mail addresses by goto-address-mode in notmuch-show buffers.
2011-10-28 16:48:58 +02:00
(require 'goto-addr)
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(require 'notmuch-lib)
emacs: create notmuch-tag.el, and move appropriate functions from notmuch.el Tagging functions are used in notmuch.el, notmuch-show.el, and notmuch-message.el. There are enough common functions for tagging that it makes sense to put them all in their own library. No code is modified, just moved around.
2012-04-14 20:52:50 +02:00
(require 'notmuch-tag)
emacs: Move body markup to a separate file Move the citation and signature markup for text/plain parts to a new file (notmuch-wash.el) and call it using a hook mechanism rather than directly.
2010-03-22 17:49:16 +01:00
(require 'notmuch-wash)
emacs: Push the cursor to point-max on `n' or `N' at the end of a thread Sebastian pointed out that the pre-JSON UI would move the cursor to the end of the buffer if `n' or `N' is hit when on the last (unread) message. Mimic that behaviour in the new UI.
2010-04-22 13:20:16 +02:00
(require 'notmuch-mua)
emacs: Add support for PGP/MIME verification/decryption A new emacs configuration variable "notmuch-crypto-process-mime" controls the processing of PGP/MIME signatures and encrypted parts. When this is set true, notmuch-query will use the notmuch show --decrypt flag to decrypt encrypted messages and/or calculate the sigstatus of signed messages. If sigstatus is available, notmuch-show will place a specially color-coded header at the begining of the signed message. Also included is the ability to switch decryption/verification on/off on the fly, which is bound to M-RET in notmuch-search-mode.
2011-05-26 03:01:19 +02:00
(require 'notmuch-crypto)
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
(require 'notmuch-print)
emacs: resume messages Provide functionality to resume editing a message previously saved with notmuch-draft-save, including decoding the X-Notmuch-Emacs-Secure header. Resume gets the raw file from notmuch and using the emacs function mime-to-mml reconstructs the message (including attachments). 'e' is bound to resume a draft from show or tree mode.
2016-11-13 15:08:50 +01:00
(require 'notmuch-draft)
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: fix declare-function definitions with related line breaks - declare-function notmuch-unthreaded lacked file name - declare-function notmuch-search had differently named last arg - note: check-declare-directory did not complain about that - declare-function notmuch-search-show-thread without nil - some functions declared to be in different file than those existed ("notmuch" -> "notmuch-lib") - some related function/declare lines were (/are now) wider than 80-columns; added line breaks (and proper indentation) there
2021-01-16 18:17:09 +01:00
(declare-function notmuch-call-notmuch-process "notmuch-lib" (&rest args))
emacs: use search-next-thread to move to next thread in show mode We should always use the dedicated search mode navigation functions, in case navigation mechanics change down the line.
2012-01-25 01:06:16 +01:00
(declare-function notmuch-search-next-thread "notmuch" nil)
emacs: add show view bindings to move to previous/next thread We have most of the plumbing in place, add the bindings M-n and M-p.
2013-05-25 23:13:30 +02:00
(declare-function notmuch-search-previous-thread "notmuch" nil)
emacs: fix declare-function definitions with related line breaks - declare-function notmuch-unthreaded lacked file name - declare-function notmuch-search had differently named last arg - note: check-declare-directory did not complain about that - declare-function notmuch-search-show-thread without nil - some functions declared to be in different file than those existed ("notmuch" -> "notmuch-lib") - some related function/declare lines were (/are now) wider than 80-columns; added line breaks (and proper indentation) there
2021-01-16 18:17:09 +01:00
(declare-function notmuch-search-show-thread "notmuch")
emacs: removed 3 duplicate functions from notmuch-show.el notmuch-show.el and notmuch.el had 3 duplicate, identical functions: notmuch-foreach-mime-part, notmuch-count-attachments and notmuch-save-attachments. Now these functions in notmuch-show.el are replaced with declare-functions pointing to "notmuch"(.el).
2013-08-26 22:21:57 +02:00
(declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
(declare-function notmuch-count-attachments "notmuch" (mm-handle))
(declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
emacs: move the show entry to tree into show.el Move the keybinding and show specific helper from tree.el to show.el
2013-11-01 10:23:45 +01:00
(declare-function notmuch-tree "notmuch-tree"
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(&optional query query-context target buffer-name
emacs: fix declare-function definitions with related line breaks - declare-function notmuch-unthreaded lacked file name - declare-function notmuch-search had differently named last arg - note: check-declare-directory did not complain about that - declare-function notmuch-search-show-thread without nil - some functions declared to be in different file than those existed ("notmuch" -> "notmuch-lib") - some related function/declare lines were (/are now) wider than 80-columns; added line breaks (and proper indentation) there
2021-01-16 18:17:09 +01:00
open-target unthreaded parent-buffer))
emacs: tree/show remove duplicate function tree overrides notmuch-show-get-prop so that it can use many of the utility function directly. Now that tree is in mainline the version from tree can be moved to show and the original overridden show version dropped.
2014-06-07 11:51:08 +02:00
(declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
emacs: fix declare-function definitions with related line breaks - declare-function notmuch-unthreaded lacked file name - declare-function notmuch-search had differently named last arg - note: check-declare-directory did not complain about that - declare-function notmuch-search-show-thread without nil - some functions declared to be in different file than those existed ("notmuch" -> "notmuch-lib") - some related function/declare lines were (/are now) wider than 80-columns; added line breaks (and proper indentation) there
2021-01-16 18:17:09 +01:00
(declare-function notmuch-unthreaded "notmuch-tree"
(&optional query query-context target buffer-name
open-target))
emacs: add a filter option to show Show the current thread with a different filter (i.e., open messages in the thread matching the new query). Bound to 'l' for "limit". Note that it is not the same as filter in search mode as it replaces the existing query rather than ANDing with it (but it does keep the thread-id part of the query).
2015-06-13 10:08:09 +02:00
(declare-function notmuch-read-query "notmuch" (prompt))
emacs: resume messages Provide functionality to resume editing a message previously saved with notmuch-draft-save, including decoding the X-Notmuch-Emacs-Secure header. Resume gets the raw file from notmuch and using the emacs function mime-to-mml reconstructs the message (including attachments). 'e' is bound to resume a draft from show or tree mode.
2016-11-13 15:08:50 +01:00
(declare-function notmuch-draft-resume "notmuch-draft" (id))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: use lexical-bindings in all libraries Doing so causes many new compile warnings. Some of these warnings concern genuine changes in behavior that have to be addressed right away. Many other warnings are due to unused variables. Nothing has changed here, except that the byte-compiler can now detect these pre-existing and harmless issues. We delay addressing these issues so that we can focus on the important ones here. A third group of warnings concern arguments that are not actually used inside the function but which cannot be removed because the functions signature is dictated by some outside convention. Silencing these warning is also delayed until subsequent commits.
2021-01-10 15:00:47 +01:00
(defvar shr-blocked-images)
(defvar gnus-blocked-images)
(defvar shr-content-function)
emacs: honour notmuch-show-text/html-blocked-images in w3m messages When mm-text-html-renderer is set to 'w3m, the variable playing the role of a regular expression for blocked images is w3m-ignored-image-url-regexp. We bind it when the renderer is not 'shr.
2021-08-04 02:02:41 +02:00
(defvar w3m-ignored-image-url-regexp)
emacs: use lexical-bindings in all libraries Doing so causes many new compile warnings. Some of these warnings concern genuine changes in behavior that have to be addressed right away. Many other warnings are due to unused variables. Nothing has changed here, except that the byte-compiler can now detect these pre-existing and harmless issues. We delay addressing these issues so that we can focus on the important ones here. A third group of warnings concern arguments that are not actually used inside the function but which cannot be removed because the functions signature is dictated by some outside convention. Silencing these warning is also delayed until subsequent commits.
2021-01-10 15:00:47 +01:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Options
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
(defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
emacs: Allow user to customize which headers are visible. Continuing our tradition of making more and more of the notmuch functionality configurable fromt eh customize interface.
2010-04-24 15:04:59 +02:00
"Headers that should be shown in a message, in this order.
For an open message, all of these headers will be made visible
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
according to `notmuch-message-headers-visible' or can be toggled
emacs: rename `notmuch-show-toggle-headers' to `notmuch-show-toggle-visibility-headers' * emacs/notmuch-show.el (notmuch-show-toggle-headers): Rename to `notmuch-show-toggle-visibility-headers'. (notmuch-show-mode-map): Update "h" binding wrt renamed `notmuch-show-toggle-headers'. (notmuch-message-headers): Update docstring wrt renamed `notmuch-show-toggle-headers'. (notmuch-message-headers-visible): Update docstring wrt renamed `notmuch-show-toggle-headers'. Also fixed a small typo. * test/emacs: Update subtest wrt renamed `notmuch-show-toggle-headers': - "notmuch-show: hide message headers (w/ notmuch-show-toggle-headers)"
2012-02-22 19:43:30 +01:00
with `notmuch-show-toggle-visibility-headers'. For a closed message,
only the first header in the list will be visible."
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type '(repeat string)
:group 'notmuch-show)
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
(defcustom notmuch-message-headers-visible t
emacs: Allow user to customize which headers are visible. Continuing our tradition of making more and more of the notmuch functionality configurable fromt eh customize interface.
2010-04-24 15:04:59 +02:00
"Should the headers be visible by default?
If this value is non-nil, then all of the headers defined in
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
`notmuch-message-headers' will be visible by default in the display
emacs: Allow user to customize which headers are visible. Continuing our tradition of making more and more of the notmuch functionality configurable fromt eh customize interface.
2010-04-24 15:04:59 +02:00
of each message. Otherwise, these headers will be hidden and
emacs: rename `notmuch-show-toggle-headers' to `notmuch-show-toggle-visibility-headers' * emacs/notmuch-show.el (notmuch-show-toggle-headers): Rename to `notmuch-show-toggle-visibility-headers'. (notmuch-show-mode-map): Update "h" binding wrt renamed `notmuch-show-toggle-headers'. (notmuch-message-headers): Update docstring wrt renamed `notmuch-show-toggle-headers'. (notmuch-message-headers-visible): Update docstring wrt renamed `notmuch-show-toggle-headers'. Also fixed a small typo. * test/emacs: Update subtest wrt renamed `notmuch-show-toggle-headers': - "notmuch-show: hide message headers (w/ notmuch-show-toggle-headers)"
2012-02-22 19:43:30 +01:00
`notmuch-show-toggle-visibility-headers' can be used to make them
visible for any given message."
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type 'boolean
:group 'notmuch-show)
emacs: Allow headers to be shown by default in show mode Add `notmuch-show-headers-visible' which, when set `t', causes headers to be shown by default.
2010-04-23 13:54:21 +02:00
emacs: make header line in notmuch-show buffers optional New notmuch-show-header-line customizable boolean to allow inhibiting a header line in notmuch-show-mode buffers (for instance, because one prefers to just include Subject in notmuch-message-headers).
2022-01-10 04:05:23 +01:00
(defcustom notmuch-show-header-line t
emacs: notmuch-show-header-line: allow format strings and functions If a string value is assigned to notmuch-show-header-line, it's used as a format string to be passed passed to format-spec with `%s` substituted by the message's subject. If a function is given, it's called with the subject as argument, and its return value used as header line. As before, t means displaying the subject and nil not using any header line. Signed-off-by: jao <jao@gnu.org> Amended-by: db, docstring spelling fix
2022-06-01 11:53:36 +02:00
"Show a header line in notmuch show buffers.
If t (the default), the header line will contain the current
message's subject.
If a string, this value is interpreted as a format string to be
passed to `format-spec` with `%s` as the substitution variable
for the message's subject. E.g., to display the subject trimmed
to a maximum of 80 columns, you could use \"%>-80s\" as format.
If you assign to this variable a function, it will be called with
the subject as argument, and the return value will be used as the
header line format. Since the function is called with the
message buffer as the current buffer, it is also possible to
access any other properties of the message, using for instance
notmuch-show functions such as
`notmuch-show-get-message-properties'.
Finally, if this variable is set to nil, no header is
displayed."
:type '(choice (const :tag "No header" ni)
(const :tag "Subject" t)
(string :tag "Format")
(function :tag "Function"))
emacs: make header line in notmuch-show buffers optional New notmuch-show-header-line customizable boolean to allow inhibiting a header line in notmuch-show-mode buffers (for instance, because one prefers to just include Subject in notmuch-message-headers).
2022-01-10 04:05:23 +01:00
:group 'notmuch-show)
emacs/show: optionally insert bodies of "deep messages" lazily This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-06-28 03:02:02 +02:00
(defcustom notmuch-show-depth-limit nil
"Depth beyond which message bodies are displayed lazily.
If bound to an integer, any message with tree depth greater than
this will have its body display lazily, initially
inserting only a button.
If this variable is set to nil (the default) no such lazy
insertion is done."
:type '(choice (const :tag "No limit" nil)
(number :tag "Limit" 10))
:group 'notmuch-show)
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(defcustom notmuch-show-height-limit nil
"Height (from leaves) beyond which message bodies are displayed lazily.
If bound to an integer, any message with height in the message
tree greater than this will have its body displayed lazily,
initially only a button.
If this variable is set to nil (the default) no such lazy
display is done."
:type '(choice (const :tag "No limit" nil)
(number :tag "Limit" 10))
:group 'notmuch-show)
emacs: Allow the display of absolute dates in the header line. Add `notmuch-show-relative-dates' to control whether the summary line in `notmuch-show' mode displays relative dates (e.g. '26 mins. ago') or the full date string from the message. Default to `t' for compatibility with the previous behaviour.
2010-05-19 08:44:18 +02:00
(defcustom notmuch-show-relative-dates t
"Display relative dates in the message summary line."
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type 'boolean
:group 'notmuch-show)
emacs: Allow the display of absolute dates in the header line. Add `notmuch-show-relative-dates' to control whether the summary line in `notmuch-show' mode displays relative dates (e.g. '26 mins. ago') or the full date string from the message. Default to `t' for compatibility with the previous behaviour.
2010-05-19 08:44:18 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
"A list of functions called to decorate the headers listed in
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
`notmuch-message-headers'.")
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Re-enable line wrapping in `notmuch-show-mode'. Turn on `visual-line-mode' via a hook, so that those who so choose can avoid it.
2012-01-26 09:17:50 +01:00
(defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
emacs: Add more functions to clean up text/plain parts Add: - notmuch-wash-wrap-long-lines: Wrap lines longer than the width of the current window whilst maintaining any citation prefix. - notmuch-wash-tidy-citations: Tidy up citations by: - compress repeated otherwise blank citation lines, - remove otherwise blank citation lines at the head and tail of a citation, - notmuch-wash-elide-blank-lines: Compress repeated blank lines and remove leading and trailing blank lines. None of these is enabled by default - add them to `notmuch-show-insert-text/plain-hook' to use. Reviewed-by: Carl Worth <cworth@cworth.org>: I previously committed a stale version of this patch.
2010-04-26 15:45:30 +02:00
"Functions called after populating a `notmuch-show' buffer."
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type 'hook
emacs: Re-enable line wrapping in `notmuch-show-mode'. Turn on `visual-line-mode' via a hook, so that those who so choose can avoid it.
2012-01-26 09:17:50 +01:00
:options '(notmuch-show-turn-on-visual-line-mode)
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:group 'notmuch-show
:group 'notmuch-hooks)
emacs: Move body markup to a separate file Move the citation and signature markup for text/plain parts to a new file (notmuch-wash.el) and call it using a hook mechanism rather than directly.
2010-03-22 17:49:16 +01:00
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(defcustom notmuch-show-insert-text/plain-hook
'(notmuch-wash-wrap-long-lines
notmuch-wash-tidy-citations
notmuch-wash-elide-blank-lines
notmuch-wash-excerpt-citations)
emacs: Add more functions to clean up text/plain parts Add: - notmuch-wash-wrap-long-lines: Wrap lines longer than the width of the current window whilst maintaining any citation prefix. - notmuch-wash-tidy-citations: Tidy up citations by: - compress repeated otherwise blank citation lines, - remove otherwise blank citation lines at the head and tail of a citation, - notmuch-wash-elide-blank-lines: Compress repeated blank lines and remove leading and trailing blank lines. None of these is enabled by default - add them to `notmuch-show-insert-text/plain-hook' to use. Reviewed-by: Carl Worth <cworth@cworth.org>: I previously committed a stale version of this patch.
2010-04-26 15:45:30 +02:00
"Functions used to improve the display of text/plain parts."
:type 'hook
emacs/notmuch-wash.el: Add `notmuch-wash-convert-inline-patch-to-part'. Detect inline patches and convert them to fake attachments, in order that `diff-mode' highlighting can be applied to the patch. This can be enabled by customising `notmuch-show-insert-text/plain-hook'.
2010-04-27 12:20:58 +02:00
:options '(notmuch-wash-convert-inline-patch-to-part
notmuch-wash-wrap-long-lines
emacs: Add more functions to clean up text/plain parts Add: - notmuch-wash-wrap-long-lines: Wrap lines longer than the width of the current window whilst maintaining any citation prefix. - notmuch-wash-tidy-citations: Tidy up citations by: - compress repeated otherwise blank citation lines, - remove otherwise blank citation lines at the head and tail of a citation, - notmuch-wash-elide-blank-lines: Compress repeated blank lines and remove leading and trailing blank lines. None of these is enabled by default - add them to `notmuch-show-insert-text/plain-hook' to use. Reviewed-by: Carl Worth <cworth@cworth.org>: I previously committed a stale version of this patch.
2010-04-26 15:45:30 +02:00
notmuch-wash-tidy-citations
notmuch-wash-elide-blank-lines
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
notmuch-wash-excerpt-citations)
:group 'notmuch-show
:group 'notmuch-hooks)
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: show: increase default max-text-part-size Currently notmuch-show-max-text-part-size is 10000 which means some relatively normal messages have all parts hidden by default. Increase this to 100000 by default. The setting was introduced to alleviate problems with notmuch being very slow on large threads. Users hitting these problems may wish to customize this variable to something smaller (like 10000).
2015-10-15 20:53:09 +02:00
(defcustom notmuch-show-max-text-part-size 100000
emacs: show: hide large text attachments by default notmuch-show can be slow displaying large attachments so hide them by default. The default maximum size is 10000 bytes/characters but it is customizable. Note that notmuch-show-insert-bodypart is also called from the reply code so we need to be a little careful.
2015-03-28 12:08:59 +01:00
"Maximum size of a text part to be shown by default in characters.
Set to 0 to show the part regardless of size."
:type 'integer
:group 'notmuch-show)
emacs: Optionally show all parts in multipart/alternative. Add a variable `notmuch-show-all-multipart/alternative-parts' that allows the user to indicate that all candidate sub-parts of a multipart/alternative part should be shown rather than just the preferred part. The default is `nil', showing only the preferred part. This is mostly a debugging aid. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:41:12 +02:00
;; Mostly useful for debugging.
emacs: show: set default show-all-multipart/alternatives to nil Now that the invisibility display of parts is present we no longer need to force the display of all multipart/alternatives: users can toggle them for themselves when needed.
2012-12-18 20:28:00 +01:00
(defcustom notmuch-show-all-multipart/alternative-parts nil
emacs: Optionally show all parts in multipart/alternative. Add a variable `notmuch-show-all-multipart/alternative-parts' that allows the user to indicate that all candidate sub-parts of a multipart/alternative part should be shown rather than just the preferred part. The default is `nil', showing only the preferred part. This is mostly a debugging aid. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:41:12 +02:00
"Should all parts of multipart/alternative parts be shown?"
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type 'boolean
:group 'notmuch-show)
emacs: Optionally show all parts in multipart/alternative. Add a variable `notmuch-show-all-multipart/alternative-parts' that allows the user to indicate that all candidate sub-parts of a multipart/alternative part should be shown rather than just the preferred part. The default is `nil', showing only the preferred part. This is mostly a debugging aid. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:41:12 +02:00
emacs: fix notmuch-show-indent-messages-width customization variable name The name was originally notmuch-indent-messages-width, which is inconsistent with our variable naming convention.
2012-01-02 23:23:02 +01:00
(defcustom notmuch-show-indent-messages-width 1
emacs: make message indentation width customisable Till now Emacs UI indents messages according to their respecive depth of neting in the thread. The actual width of indentation per level is hardcoded to `1' space. This patch makes message indentation customisable by introducing a variable `notmuch-indent-messages-width' which defaults to `1', which is the same as before. Felix could set this variable to `0' in order to disable indentation, I tested it with a value of `4' for a clearer separation of messages in a thread.
2011-11-24 23:03:21 +01:00
"Width of message indentation in threads.
Messages are shown indented according to their depth in a thread.
This variable determines the width of this indentation measured
in number of blanks. Defaults to `1', choose `0' to disable
indentation."
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type 'integer
:group 'notmuch-show)
emacs: make message indentation width customisable Till now Emacs UI indents messages according to their respecive depth of neting in the thread. The actual width of indentation per level is hardcoded to `1' space. This patch makes message indentation customisable by introducing a variable `notmuch-indent-messages-width' which defaults to `1', which is the same as before. Felix could set this variable to `0' in order to disable indentation, I tested it with a value of `4' for a clearer separation of messages in a thread.
2011-11-24 23:03:21 +01:00
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
(defcustom notmuch-show-indent-multipart nil
"Should the sub-parts of a multipart/* part be indented?"
;; dme: Not sure which is a good default.
emacs: logically group def{custom,face}s To allow for expansion whilst keeping everything tidy and organized, move all defcustom/defface variables to the following subgroups, defined in notmuch-lib.el: - Hello - Search - Show - Send - Crypto - Hooks - External Commands - Appearance As an added benefit, defcustom keyword args are now consistently ordered as they appear @ defcustom's docstring (OCD much?). Proper defgroup docstrings and various other improvements by courtesy of Austin Clements.
2012-01-16 11:38:33 +01:00
:type 'boolean
:group 'notmuch-show)
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
(defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
"Default part header button action (on ENTER or mouse click)."
:group 'notmuch-show
:type '(choice (const :tag "Save part"
notmuch-show-save-part)
(const :tag "View part"
notmuch-show-view-part)
(const :tag "View interactively"
notmuch-show-interactively-view-part)))
emacs: Add `notmuch-show-only-matching-messages'. Allow the user to choose that only matching messages are shown by default.
2012-02-08 09:02:18 +01:00
(defcustom notmuch-show-only-matching-messages nil
"Only matching messages are shown by default."
:type 'boolean
:group 'notmuch-show)
emacs: Add a defcustom that specifies regexp for blocked remote images. It's default value is ".", meaning all remote images will be blocked by default.
2015-02-02 22:04:52 +01:00
;; By default, block all external images to prevent privacy leaks and
;; potential attacks.
(defcustom notmuch-show-text/html-blocked-images "."
"Remote images that have URLs matching this regexp will be blocked."
:type '(choice (const nil) regexp)
:group 'notmuch-show)
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Variables
emacs: use defvar-local It is available since Emacs 24.3 and we require at least Emacs 25.
2020-11-16 22:28:38 +01:00
(defvar-local notmuch-show-thread-id nil)
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
emacs: use defvar-local It is available since Emacs 24.3 and we require at least Emacs 25.
2020-11-16 22:28:38 +01:00
(defvar-local notmuch-show-parent-buffer nil)
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
emacs: use defvar-local It is available since Emacs 24.3 and we require at least Emacs 25.
2020-11-16 22:28:38 +01:00
(defvar-local notmuch-show-query-context nil)
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
emacs: use defvar-local It is available since Emacs 24.3 and we require at least Emacs 25.
2020-11-16 22:28:38 +01:00
(defvar-local notmuch-show-process-crypto nil)
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
emacs: use defvar-local It is available since Emacs 24.3 and we require at least Emacs 25.
2020-11-16 22:28:38 +01:00
(defvar-local notmuch-show-elide-non-matching-messages nil)
emacs: Allow `notmuch-show-mode' to display only matching messages. The current behaviour (all messages shown, non-matching collapsed) is retained as the default. Type '!' to switch to showing only the matching messages - non-matching messages are not available. '!' will switch back to showing everything.
2012-02-08 09:02:12 +01:00
emacs: use defvar-local It is available since Emacs 24.3 and we require at least Emacs 25.
2020-11-16 22:28:38 +01:00
(defvar-local notmuch-show-indent-content t)
emacs: Allow the indentation of content to be toggled. Very deeply indented content is sometimes difficult to read (particular for something like patches). Allow the indentation of the content to be toggled with '<'. Indentation of the header lines is not affected, so it remains possible to see the structure of the thread.
2012-02-08 09:02:14 +01:00
emacs/show: add parameter notmuch-show-single-message This dynamically bound variable can be set when the caller of notmuch-show guarantees that exactly one message will match the query. It avoids transporting and parsing the complete thread structure.
2021-06-26 14:04:27 +02:00
(defvar-local notmuch-show-single-message nil)
emacs: show: stop stderr appearing in buffer In emacs 24.3+ the stdout/stderr from externally displaying an attachment gets inserted into the show buffer. This is caused by changes in mm-display-external in mm-decode.el. Ideally, we would put this output in the notmuch errors buffer but the handler is called asynchronously so we don't know when the output will appear. Thus if we put it straight into the errors buffer it could get interleaved with other errors. Also we can't easily tell when we have got all the error output so can't wait until the process is complete. One solution would be to create a new buffer for the stderr of each attachment viewed. Again, since we can't tell when the process has finished, we can't close these buffers automatically so this will leave lots of buffers around. Thus we add a debug variable notmuch-show-attachment-debug: it this is non-nil we create a new buffer for each viewer; if this variable is nil we just use a temp buffer which means all error output is discarded (this is the same behaviour as with emacs pre 24.3).
2013-11-18 22:10:33 +01:00
(defvar notmuch-show-attachment-debug nil
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"If t log stdout and stderr from attachment handlers.
emacs: show: stop stderr appearing in buffer In emacs 24.3+ the stdout/stderr from externally displaying an attachment gets inserted into the show buffer. This is caused by changes in mm-display-external in mm-decode.el. Ideally, we would put this output in the notmuch errors buffer but the handler is called asynchronously so we don't know when the output will appear. Thus if we put it straight into the errors buffer it could get interleaved with other errors. Also we can't easily tell when we have got all the error output so can't wait until the process is complete. One solution would be to create a new buffer for the stderr of each attachment viewed. Again, since we can't tell when the process has finished, we can't close these buffers automatically so this will leave lots of buffers around. Thus we add a debug variable notmuch-show-attachment-debug: it this is non-nil we create a new buffer for each viewer; if this variable is nil we just use a temp buffer which means all error output is discarded (this is the same behaviour as with emacs pre 24.3).
2013-11-18 22:10:33 +01:00
When set to nil (the default) stdout and stderr from attachment
handlers is discarded. When set to t the stdout and stderr from
each attachment handler is logged in buffers with names beginning
emacs: more cleanup since dropping support for Emacs 24 Notmuch requires at least version 25 of Emacs now. Adjust comments that previously referenced version 24 specifically, even though they also apply to later releases. Remove documentation and code that no longer applies. - `mm-shr' no longer references `gnus-inhibit-images'.
2020-11-16 22:28:24 +01:00
\" *notmuch-part*\".")
emacs: show: stop stderr appearing in buffer In emacs 24.3+ the stdout/stderr from externally displaying an attachment gets inserted into the show buffer. This is caused by changes in mm-display-external in mm-decode.el. Ideally, we would put this output in the notmuch errors buffer but the handler is called asynchronously so we don't know when the output will appear. Thus if we put it straight into the errors buffer it could get interleaved with other errors. Also we can't easily tell when we have got all the error output so can't wait until the process is complete. One solution would be to create a new buffer for the stderr of each attachment viewed. Again, since we can't tell when the process has finished, we can't close these buffers automatically so this will leave lots of buffers around. Thus we add a debug variable notmuch-show-attachment-debug: it this is non-nil we create a new buffer for each viewer; if this variable is nil we just use a temp buffer which means all error output is discarded (this is the same behaviour as with emacs pre 24.3).
2013-11-18 22:10:33 +01:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Options
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
(defcustom notmuch-show-stash-mlarchive-link-alist
emacs: update default mailing list archives for stashing links Gmane web interface is long gone, remove it. Make MARC the new default. Update LKML to Lore, where it already redirects anyway. Also add Notmuch web archive.
2021-05-21 14:51:26 +02:00
'(("MARC" . "https://marc.info/?i=")
Use https instead of http where possible Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-02 18:26:14 +02:00
("Mail Archive, The" . "https://mid.mail-archive.com/")
emacs: update default mailing list archives for stashing links Gmane web interface is long gone, remove it. Make MARC the new default. Update LKML to Lore, where it already redirects anyway. Also add Notmuch web archive.
2021-05-21 14:51:26 +02:00
("Lore" . "https://lore.kernel.org/r/")
("Notmuch" . "https://nmbug.notmuchmail.org/nmweb/show/")
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
;; FIXME: can these services be searched by `Message-Id' ?
;; ("MarkMail" . "http://markmail.org/")
;; ("Nabble" . "http://nabble.com/")
;; ("opensubscriber" . "http://opensubscriber.com/")
)
"List of Mailing List Archives to use when stashing links.
emacs: allow functions in notmuch-show-stash-mlarchive-link-alist Some archives may use a more complicated scheme for referring to messages than just concatenated url and message-id. In particular, patchwork requires a query to translate message-id to a patchwork patch id. Allow functions in notmuch-show-stash-mlarchive-link-alist to facilitate this. For example, one could use something like this for patchwork. (lambda (message-id) (concat "http://patchwork.example.com/patch/" (nth 0 (split-string (car (last (process-lines "pwclient" "search" "-n" "1" "-m" (concat "<" message-id ">"))))))))
2014-05-01 14:35:11 +02:00
This list is used for generating a Mailing List Archive reference
URI with the current message's Message-Id in
`notmuch-show-stash-mlarchive-link'.
If the cdr of the alist element is not a function, the cdr is
expected to contain a URI that is concatenated with the current
message's Message-Id to create a ML archive reference URI.
If the cdr is a function, the function is called with the
Message-Id as the argument, and the function is expected to
return the ML archive reference URI."
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
:type '(alist :key-type (string :tag "Name")
emacs: allow functions in notmuch-show-stash-mlarchive-link-alist Some archives may use a more complicated scheme for referring to messages than just concatenated url and message-id. In particular, patchwork requires a query to translate message-id to a patchwork patch id. Allow functions in notmuch-show-stash-mlarchive-link-alist to facilitate this. For example, one could use something like this for patchwork. (lambda (message-id) (concat "http://patchwork.example.com/patch/" (nth 0 (split-string (car (last (process-lines "pwclient" "search" "-n" "1" "-m" (concat "<" message-id ">"))))))))
2014-05-01 14:35:11 +02:00
:value-type (choice
(string :tag "URL")
(function :tag "Function returning the URL")))
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
:group 'notmuch-show)
emacs: update default mailing list archives for stashing links Gmane web interface is long gone, remove it. Make MARC the new default. Update LKML to Lore, where it already redirects anyway. Also add Notmuch web archive.
2021-05-21 14:51:26 +02:00
(defcustom notmuch-show-stash-mlarchive-link-default "MARC"
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
"Default Mailing List Archive to use when stashing links.
This is used when `notmuch-show-stash-mlarchive-link' isn't
provided with an MLA argument nor `completing-read' input."
:type `(choice
,@(mapcar
(lambda (mla)
(list 'const :tag (car mla) :value (car mla)))
notmuch-show-stash-mlarchive-link-alist))
:group 'notmuch-show)
notmuch-show: add notmuch-show-mark-read-tags option The `notmuch-show-mark-read-tags' lists tags that are to be applied when message is read. By default, the only value is "-unread" which will remove the unread tag. Among other uses, this variable can be used to stop notmuch-show from modifying tags when message is shown (by setting the variable to an empty list).
2012-08-21 15:13:36 +02:00
(defcustom notmuch-show-mark-read-tags '("-unread")
emacs: add support for reversing notmuch-show-mark-read tag changes Since marking a message as read can now be a user customized set of tag changes, make reversing this easier. Allow a prefix argument to notmuch-show-mark-read to reverse the marking as read, similar to the unarchiving in notmuch-show-archive-message. While at it, update the relevant documentation to match that of other automatic tagging (i.e. archive and reply).
2012-09-06 17:32:42 +02:00
"List of tag changes to apply to a message when it is marked as read.
Tags starting with \"+\" (or not starting with either \"+\" or
\"-\") in the list will be added, and tags starting with \"-\"
will be removed from the message being marked as read.
For example, if you wanted to remove an \"unread\" tag and add a
\"read\" tag (which would make little sense), you would set:
(\"-unread\" \"+read\")"
notmuch-show: add notmuch-show-mark-read-tags option The `notmuch-show-mark-read-tags' lists tags that are to be applied when message is read. By default, the only value is "-unread" which will remove the unread tag. Among other uses, this variable can be used to stop notmuch-show from modifying tags when message is shown (by setting the variable to an empty list).
2012-08-21 15:13:36 +02:00
:type '(repeat string)
:group 'notmuch-show)
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
emacs: show: document the mark unread defcustom function
2014-09-06 18:22:10 +02:00
"Function to control which messages are marked read.
The function should take two arguments START and END which will
be the start and end of the visible portion of the buffer and
should mark the appropriate messages read by applying
`notmuch-show-mark-read'. This function will be called after
every user interaction with notmuch."
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
:type 'function
:group 'notmuch-show)
notmuch-show: add notmuch-show-mark-read-tags option The `notmuch-show-mark-read-tags' lists tags that are to be applied when message is read. By default, the only value is "-unread" which will remove the unread tag. Among other uses, this variable can be used to stop notmuch-show from modifying tags when message is shown (by setting the variable to an empty list).
2012-08-21 15:13:36 +02:00
Add indentation to imenu in notmuch-show
2017-06-18 12:04:35 +02:00
(defcustom notmuch-show-imenu-indent nil
"Should Imenu display messages indented.
By default, Imenu (see Info node `(emacs) Imenu') in a
notmuch-show buffer displays all messages straight. This is
because the default Emacs frontend for Imenu makes it difficult
to select an Imenu entry with spaces in front. Other imenu
frontends such as counsel-imenu does not have this limitation.
In these cases, Imenu entries can be indented to reflect the
position of the message in the thread."
:type 'boolean
:group 'notmuch-show)
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Utilities
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defmacro with-current-notmuch-show-message (&rest body)
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Evaluate body with current buffer set to the text of current message."
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
`(save-excursion
emacs: Access raw messages via cat subcommand This patch modifies the following commands to access the messages via cat subcommand: - view/save attachments ('v', 'w'), - view a raw message ('V') and - pipe a message to a command ('|'). With this patch, it is straightforward to use notmuch emacs interface with a remote database accessed over SSH. To do this, it is sufficient to redefine notmuch-command variable to contain the name of a script containing: ssh user@host notmuch "$@" If the ssh client has enabled connection sharing (ControlMaster option in OpenSSH), the emacs interface is almost as responsive as when notmuch is invoked locally.
2010-10-22 11:28:04 +02:00
(let ((id (notmuch-show-get-message-id)))
(let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
(with-current-buffer buf
emacs: less guessing of character set in messages The macro with-current-notmuch-show-message executes command `notmuch show --format=raw id:...` which just outputs the contents of the mail file verbatim (into temporary buffer). In case e.g. utf-8 locale is used the temporary buffer has buffer-file-coding-system as utf-8. In this case Emacs converts the data to multibyte format, guessing that input is in utf-8. However, the "raw" (MIME) message may contain octet data in any other 8bit format, and as no (MIME-)content spesific handling to the message is done at this point, conversion to other formats may lose information. By setting coding-system-for-read 'no-conversion drops the conversion part and makes this handle input as notmuch-get-bodypart-internal() does. This marks the broken test in previous change fixed.
2012-11-18 21:06:25 +01:00
(let ((coding-system-for-read 'no-conversion))
emacs: wrap call-process Provide safe working directory
2021-09-11 16:04:08 +02:00
(notmuch--call-process notmuch-command nil t nil "show" "--format=raw" id))
emacs: `with-current-notmuch-show-message' should not leak `coding-system-for-read' `with-current-notmuch-show-message' applies a `no-conversion' coding system when reading a raw message from notmuch. That coding system should _not_ be applied when the body of the macro is evaluated, as it can cause file operations used during that evaluation to incorrectly apply the `no-conversion' coding system. This was discovered when a user's .signature file contained non-ASCII characters. When a message is forwarded, the `no-conversion' coding system was applied to the reading of the .signature file, resulting in raw rather than UTF-8 interpretation of the data.
2014-11-18 08:03:17 +01:00
,@body)
(kill-buffer buf)))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Re-enable line wrapping in `notmuch-show-mode'. Turn on `visual-line-mode' via a hook, so that those who so choose can avoid it.
2012-01-26 09:17:50 +01:00
(defun notmuch-show-turn-on-visual-line-mode ()
"Enable Visual Line mode."
(visual-line-mode t))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Commands
emacs: Remove v command This removes the v command, since we now have much nicer part commands, and deprecates the underlying notmuch-show-view-all-mime-parts. This also means that people who try using the old unprefixed 'v' command on a part button will no longer be greeted by ALL of their parts popping up.
2013-06-03 17:54:55 +02:00
;; DEPRECATED in Notmuch 0.16 since we now have convenient part
;; commands. We'll keep the command around for a version or two in
;; case people want to bind it themselves.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-view-all-mime-parts ()
"Use external viewers to view all attachments from the current message."
(interactive)
(with-current-notmuch-show-message
emacs/*.el: changed one-char comment prefix ';' to two; ';;' In order for emacs (indent-region) to (re)indent emacs lisp properly there needs to be at least 2 comment characters (;;).
2012-01-21 15:44:28 +01:00
;; We override the mm-inline-media-tests to indicate which message
;; parts are already sufficiently handled by the original
;; presentation of the message in notmuch-show mode. These parts
;; will be inserted directly into the temporary buffer of
;; with-current-notmuch-show-message and silently discarded.
;;
;; Any MIME part not explicitly mentioned here will be handled by an
;; external viewer as configured in the various mailcap files.
emacs: Closing parenthesis go on the same line
2020-08-08 13:49:39 +02:00
(let ((mm-inline-media-tests
'(("text/.*" ignore identity)
("application/pgp-signature" ignore identity)
("multipart/alternative" ignore identity)
("multipart/mixed" ignore identity)
("multipart/related" ignore identity))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(mm-display-parts (mm-dissect-buffer)))))
(defun notmuch-show-save-attachments ()
"Save all attachments from the current message."
(interactive)
(with-current-notmuch-show-message
(let ((mm-handle (mm-dissect-buffer)))
(notmuch-save-attachments
mm-handle (> (notmuch-count-attachments mm-handle) 1))))
(message "Done"))
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
(defun notmuch-show-with-message-as-text (fn)
"Apply FN to a text representation of the current message.
FN is called with one argument, the message properties. It should
operation on the contents of the current buffer."
;; Remake the header to ensure that all information is available.
(let* ((to (notmuch-show-get-to))
(cc (notmuch-show-get-cc))
(from (notmuch-show-get-from))
(subject (notmuch-show-get-subject))
(date (notmuch-show-get-date))
(tags (notmuch-show-get-tags))
(depth (notmuch-show-get-depth))
(header (concat
"Subject: " subject "\n"
"To: " to "\n"
emacs: use string-empty-p
2021-01-10 15:01:09 +01:00
(if (not (string-empty-p cc))
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
(concat "Cc: " cc "\n")
"")
"From: " from "\n"
"Date: " date "\n"
(if tags
(concat "Tags: "
(mapconcat #'identity tags ", ") "\n")
"")))
(all (buffer-substring (notmuch-show-message-top)
(notmuch-show-message-bottom)))
emacs: Allow the indentation of content to be toggled. Very deeply indented content is sometimes difficult to read (particular for something like patches). Allow the indentation of the content to be toggled with '<'. Indentation of the header lines is not affected, so it remains possible to see the structure of the thread.
2012-02-08 09:02:14 +01:00
(props (notmuch-show-get-message-properties))
(indenting notmuch-show-indent-content))
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
(with-temp-buffer
(insert all)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when indenting
(indent-rigidly (point-min)
(point-max)
(- (* notmuch-show-indent-messages-width depth))))
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
;; Remove the original header.
(goto-char (point-min))
(re-search-forward "^$" (point-max) nil)
(delete-region (point-min) (point))
(insert header)
(funcall fn props))))
(defun notmuch-show-print-message ()
"Print the current message."
(interactive)
(notmuch-show-with-message-as-text 'notmuch-print-message))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Headers
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-fontify-header ()
(let ((face (cond
((looking-at "[Tt]o:")
'message-header-to)
((looking-at "[Bb]?[Cc][Cc]:")
'message-header-cc)
((looking-at "[Ss]ubject:")
'message-header-subject)
(t
'message-header-other))))
(overlay-put (make-overlay (point) (re-search-forward ":"))
'face 'message-header-name)
(overlay-put (make-overlay (point) (re-search-forward ".*$"))
'face face)))
(defun notmuch-show-colour-headers ()
"Apply some colouring to the current headers."
(goto-char (point-min))
(while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
(notmuch-show-fontify-header)
(forward-line)))
(defun notmuch-show-spaces-n (n)
"Return a string comprised of `n' spaces."
(make-string n ? ))
(defun notmuch-show-update-tags (tags)
"Update the displayed tags of the current message."
(save-excursion
emacs/show: use n-s-i-headerline to update tags Although this has more steps than the previous regular expression search and replace, it should be more robust against changes in the headerline format, such as the inclusion of duplicate numbers (which broke the previous version).
2022-11-11 22:48:31 +01:00
(let ((inhibit-read-only t)
(start (notmuch-show-message-top))
(depth (notmuch-show-get-prop :depth))
(orig-tags (notmuch-show-get-prop :orig-tags))
(props (notmuch-show-get-message-properties))
(extent (notmuch-show-message-extent)))
(goto-char start)
(notmuch-show-insert-headerline props depth tags orig-tags)
(put-text-property start (1+ start)
:notmuch-message-properties props)
(put-text-property (car extent) (cdr extent) :notmuch-message-extent extent)
;; delete original headerline, but do not save to kill ring
(delete-region (point) (1+ (line-end-position))))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: Split the function notmuch-show-clean-address This function is also used by pick so split it out in preperation for moving to lib. In fact, pick and show want a slightly different combination of name and email on return so make the separated function return them as a pair, and let show or pick extract the combination they want from that.
2012-07-31 18:29:39 +02:00
(defun notmuch-clean-address (address)
"Try to clean a single email ADDRESS for display. Return a cons
cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
parsing fails."
Make `notmuch-show-clean-address' parsing-error-proof. Mail-header-parse-address may fail for an invalid address. Before the change, this would result in empty notmuch-show buffer with an error message like: Scan error: "Unbalanced parentheses". The patch wraps the function in condition-case and returns unchanged address in case of error.
2011-05-12 15:56:25 +02:00
(condition-case nil
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
(let (p-name p-address)
;; It would be convenient to use `mail-header-parse-address',
;; but that expects un-decoded mailbox parts, whereas our
;; mailbox parts are already decoded (and hence may contain
;; UTF-8). Given that notmuch should handle most of the awkward
;; cases, some simple string deconstruction should be sufficient
;; here.
(cond
;; "User <user@dom.ain>" style.
((string-match "\\(.*\\) <\\(.*\\)>" address)
emacs: Only set one variable per setq form It's a bit weird to avoid having to write the "(setq ... )" more than once, just because we can. In a language that uses '=' for the same purpose we also happily use that once per assignment. While there are no benefit to using just one 'setq' there are some drawbacks. It is not always clear on first what is a key and what a value and as a result it is easy to make a mistake. Also it becomes harder to comment out just one assignment.
2020-08-08 13:49:40 +02:00
(setq p-name (match-string 1 address))
(setq p-address (match-string 2 address)))
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
;; "<user@dom.ain>" style.
((string-match "<\\(.*\\)>" address)
(setq p-address (match-string 1 address)))
;; Everything else.
(t
(setq p-address address)))
(when p-name
;; Remove elements of the mailbox part that are not relevant for
;; display, even if they are required during transport:
;;
;; Backslashes.
(setq p-name (replace-regexp-in-string "\\\\" "" p-name))
;; Outer single and double quotes, which might be nested.
(cl-loop with start-of-loop
do (setq start-of-loop p-name)
when (string-match "^\"\\(.*\\)\"$" p-name)
do (setq p-name (match-string 1 p-name))
when (string-match "^'\\(.*\\)'$" p-name)
do (setq p-name (match-string 1 p-name))
until (string= start-of-loop p-name)))
;; If the address is 'foo@bar.com <foo@bar.com>' then show just
;; 'foo@bar.com'.
(when (string= p-name p-address)
(setq p-name nil))
(cons p-address p-name))
emacs: Split the function notmuch-show-clean-address This function is also used by pick so split it out in preperation for moving to lib. In fact, pick and show want a slightly different combination of name and email on return so make the separated function return them as a pair, and let show or pick extract the combination they want from that.
2012-07-31 18:29:39 +02:00
(error (cons address nil))))
(defun notmuch-show-clean-address (address)
emacs: Improve doc-strings - The first sentence should fit on the first line in full. This is even the case when that causes the line to get a bit long. If it gets very long, then it should be made shorter. - Even even the second sentence would fit on the first line, if it just provides some details, then it shouldn't be done. - Symbols are quoted like `so'. - There is no clear rule on how to (not) quote non-atomic s-expressions, but quoting like '(this) is definitely weird. - It is a good idea to remember that \" becomes " and to take that in mind when adjusting the automatic filling by hand. - Use the imperative form. - Arguments are written in all uppercase.
2020-08-08 13:49:50 +02:00
"Try to clean a single email ADDRESS for display.
Return unchanged ADDRESS if parsing fails."
emacs: Split the function notmuch-show-clean-address This function is also used by pick so split it out in preperation for moving to lib. In fact, pick and show want a slightly different combination of name and email on return so make the separated function return them as a pair, and let show or pick extract the combination they want from that.
2012-07-31 18:29:39 +02:00
(let* ((clean-address (notmuch-clean-address address))
(p-address (car clean-address))
(p-name (cdr clean-address)))
;; If no name, return just the address.
(if (not p-name)
p-address
;; Otherwise format the name and address together.
(concat p-name " <" p-address ">"))))
emacs: Show cleaner `From:' addresses in the summary line. Remove double quotes and flatten "foo@bar.com <foo@bar.com>" to "foo@bar.com". Edited-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net> (clean up expected output for emacs tests). Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-19 12:21:05 +02:00
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(defun notmuch-show--mark-height (tree)
"Calculate and cache height (distance from deepest descendent)"
(let* ((msg (car tree))
(children (cadr tree))
(cached-height (plist-get msg :height)))
(or cached-height
(let ((height
(if (null children) 0
(1+ (apply #'max (mapcar #'notmuch-show--mark-height children))))))
(plist-put msg :height height)
height))))
emacs/show: add optional orig-tags argument to n-s-i-headerline This will support use of this function in notmuch-show-update-tags.
2022-11-11 22:48:30 +01:00
(defun notmuch-show-insert-headerline (msg-plist depth tags &optional orig-tags)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Insert a notmuch style headerline based on HEADERS for a
message at DEPTH in the current thread."
emacs/show: use plist to pass message info to n-s-insert-headerline This should allow calling notmuch-show-insert-headerline from other places without duplicating the set of plist accesses.
2022-11-11 22:48:29 +01:00
(let* ((start (point))
(headers (plist-get msg-plist :headers))
(duplicate (or (plist-get msg-plist :duplicate) 0))
(file-count (length (plist-get msg-plist :filename)))
(date (or (and notmuch-show-relative-dates
(plist-get msg-plist :date_relative))
(plist-get headers :Date)))
(from (notmuch-sanitize
Emacs: Ensure left-to-right display for message headers In notmuch-show buffer insert invisible U+200E LEFT-TO-RIGHT MARK character at the beginning of message header paragraph if the From header contains a right-to-left character. This ensures that the header paragraph is always rendered in left-to-right mode. See Emacs Lisp reference manual section "(elisp) Bidirectional Display" for more info.
2020-08-07 06:46:41 +02:00
(notmuch-show-clean-address (plist-get headers :From)))))
(when (string-match "\\cR" from)
;; If the From header has a right-to-left character add
;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
;; the header paragraph as left-to-right text.
(insert (propertize (string ?\x200e) 'invisible t)))
Emacs: Indent first header line only when indentation is turned on Previously in message-show mode message's first header line (From header) was always indented, even if user had turned thread indentation off with "<" (notmuch-show-toggle-thread-indentation) command. This change modifies notmuch-show-insert-headerline function so that it doesn't indent the first header line if notmuch-show-indent-content variable is nil. This change also modifies tests so that they expect this new output format: test/emacs-show.expected-output/notmuch-show-indent-thread-content-off
2020-08-15 08:28:29 +02:00
(insert (if notmuch-show-indent-content
(notmuch-show-spaces-n (* notmuch-show-indent-messages-width
depth))
"")
Emacs: Ensure left-to-right display for message headers In notmuch-show buffer insert invisible U+200E LEFT-TO-RIGHT MARK character at the beginning of message header paragraph if the From header contains a right-to-left character. This ensures that the header paragraph is always rendered in left-to-right mode. See Emacs Lisp reference manual section "(elisp) Bidirectional Display" for more info.
2020-08-07 06:46:41 +02:00
from
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
" ("
date
") ("
emacs/show: add optional orig-tags argument to n-s-i-headerline This will support use of this function in notmuch-show-update-tags.
2022-11-11 22:48:30 +01:00
(notmuch-tag-format-tags tags (or orig-tags tags))
emacs/show: display count of duplicates in headerline There is no real cost here, except screen real estate. Some people might prefer hiding the duplicate count, but we leave that for a future commit.
2022-07-01 23:45:46 +02:00
")")
(insert
(if (> file-count 1)
(let ((txt (format "%d/%d\n" duplicate file-count)))
(concat
CLI/reply: support --duplicate argument We want the reply used to match that shown e.g. in the emacs interface. As a first step provide that functionality on the command line. Schema does not need updating as the duplicate key was already present (with a constant value of 1).
2022-07-01 23:45:47 +02:00
(notmuch-show-spaces-n (max 0 (- (window-width) (+ (current-column) (length txt)))))
emacs/show: display count of duplicates in headerline There is no real cost here, except screen real estate. Some people might prefer hiding the duplicate count, but we leave that for a future commit.
2022-07-01 23:45:46 +02:00
txt))
"\n"))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(overlay-put (make-overlay start (point))
'face 'notmuch-message-summary-face)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-insert-header (header header-value)
"Insert a single header."
emacs: Sanitize authors and subjects in search and show Authors and subjects can contain embedded, encoded control characters like "\n" and "\t" that mess up display. Transform control characters into spaces everywhere we display them in search and show.
2013-10-11 15:53:39 +02:00
(insert header ": " (notmuch-sanitize header-value) "\n"))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-insert-headers (headers)
"Insert the headers of the current message."
(let ((start (point)))
Don't quote lambda forms This generates byte-compiler warnings on (at least) current trunk versions of Emacs. The quote is not necessary; lambda forms are self-quoting.
2011-12-17 16:47:48 +01:00
(mapc (lambda (header)
(let* ((header-symbol (intern (concat ":" header)))
(header-value (plist-get headers header-symbol)))
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (and header-value
(not (string-equal "" header-value)))
(notmuch-show-insert-header header header-value))))
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
notmuch-message-headers)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(save-excursion
(save-restriction
(narrow-to-region start (point-max))
(run-hooks 'notmuch-show-markup-headers-hook)))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Parts
emacs/notmuch-show.el: Part headers are real buttons that save the part Convert the part headers into buttons that save the part when activated.
2010-04-21 22:19:19 +02:00
(define-button-type 'notmuch-show-part-button-type
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
'action 'notmuch-show-part-button-default
emacs/notmuch-show.el: Part headers are real buttons that save the part Convert the part headers into buttons that save the part when activated.
2010-04-21 22:19:19 +02:00
'follow-link t
emacs: show: make buttons select window Emacs has two button type objects: widgets (as used for saved searches in notmuch-hello) and buttons as used by parts/citations and id links in notmuch-show. These two behave subtly differently when clicked with the mouse: widgets select the window clicked before running the action, buttons do not. This patch makes all of these behave the same: clicking always selects the clicked window. It does this by defining a notmuch-button-type supertype that the other notmuch buttons can inherit from. This supertype binds the mouse-action to select the window and then activate the button.
2013-01-07 22:07:20 +01:00
'face 'message-mml
:supertype 'notmuch-button-type)
emacs/notmuch-show.el: Part headers are real buttons that save the part Convert the part headers into buttons that save the part when activated.
2010-04-21 22:19:19 +02:00
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-header (_nth content-type declared-type
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
&optional name comment)
emacs: Various cosmetic changes
2020-08-08 13:49:53 +02:00
(let ((base-label (concat (and name (concat name ": "))
emacs: show: modify insert-part-header to save the button text This just make notmuch-show-insert-part-header save the basic button text for parts as an attribute. This makes it simpler for the button action (added in a later patch) to reword the label as appropriate (eg append "(not shown)" or not as appropriate).
2012-12-18 20:27:57 +01:00
declared-type
emacs: Use 'and' instead of 'when' when the return value matters Also do so for some 'if' forms that lack an ELSE part. Even go as far as using 'and' and 'not' instead of 'unless'.
2020-08-08 13:49:41 +02:00
(and (not (string-equal declared-type content-type))
(concat " (as " content-type ")"))
emacs: show: modify insert-part-header to save the button text This just make notmuch-show-insert-part-header save the basic button text for parts as an attribute. This makes it simpler for the button action (added in a later patch) to reword the label as appropriate (eg append "(not shown)" or not as appropriate).
2012-12-18 20:27:57 +01:00
comment)))
emacs: Various cosmetic changes
2020-08-08 13:49:53 +02:00
(prog1 (insert-button
(concat "[ " base-label " ]")
:base-label base-label
:type 'notmuch-show-part-button-type
:notmuch-part-hidden nil)
(insert "\n"))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: show: add invisibility button action This adds a button action to show hidden parts. In this version "RET" toggles the visibility of any part which puts content in the buffer (as opposed to attachments such as application/pdf). The button is used to hide parts when appropriate (eg text/html in multipart/alternative).
2012-12-18 20:27:59 +01:00
(defun notmuch-show-toggle-part-invisibility (&optional button)
(interactive)
emacs/show: Accommodate the lack of part header buttons Various pieces of code assumed (reasonably) that part header buttons are present. Modify them to avoid problems if no part headers were inserted.
2016-02-20 19:24:37 +01:00
(let ((button (or button (button-at (point)))))
(when button
(let ((overlay (button-get button 'overlay))
(lazy-part (button-get button :notmuch-lazy-part)))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
;; We have a part to toggle if there is an overlay or if there
;; is a lazy part. If neither is present we cannot toggle the
;; part so we just return nil.
emacs/show: Accommodate the lack of part header buttons Various pieces of code assumed (reasonably) that part header buttons are present. Modify them to avoid problems if no part headers were inserted.
2016-02-20 19:24:37 +01:00
(when (or overlay lazy-part)
(let* ((show (button-get button :notmuch-part-hidden))
(new-start (button-start button))
(button-label (button-get button :base-label))
(old-point (point))
(properties (text-properties-at (button-start button)))
(inhibit-read-only t))
;; Toggle the button itself.
(button-put button :notmuch-part-hidden (not show))
(goto-char new-start)
(insert "[ " button-label (if show " ]" " (hidden) ]"))
(set-text-properties new-start (point) properties)
(let ((old-end (button-end button)))
(move-overlay button new-start (point))
(delete-region (point) old-end))
(goto-char (min old-point (1- (button-end button))))
;; Return nil if there is a lazy-part, it is empty, and we are
;; trying to show it. In all other cases return t.
(if lazy-part
(when show
(button-put button :notmuch-lazy-part nil)
(notmuch-show-lazy-part lazy-part button))
emacs/show: special case toggling display of images According to emacs upstream [1], we can't expect overlay invisibility and images to get along. This commit uses the previously stashed undisplayer functions to actually remove the images from the buffer. When the image is toggled, it is essentially redisplayed from scratch, using the previously stashed redisplay data. [1]: https://lists.gnu.org/archive/html/emacs-devel/2023-08/msg00593.html
2023-09-24 11:51:52 +02:00
(let* ((part (plist-get properties :notmuch-part))
(undisplayer (plist-get part :undisplayer))
(mime-type (plist-get part :computed-type))
(redisplay-data (button-get button
:notmuch-redisplay-data))
(imagep (string-match "^image/" mime-type)))
(cond
((and imagep (not show) undisplayer)
;; call undisplayer thunk created by gnus.
(funcall undisplayer)
;; there is an extra newline left
(delete-region
(+ 1 (button-end button))
(+ 2 (button-end button))))
((and imagep show redisplay-data)
(notmuch-show-lazy-part redisplay-data button))
(t
(overlay-put overlay 'invisible (not show)))))
emacs/show: Accommodate the lack of part header buttons Various pieces of code assumed (reasonably) that part header buttons are present. Modify them to avoid problems if no part headers were inserted.
2016-02-20 19:24:37 +01:00
t)))))))
emacs: show: add invisibility button action This adds a button action to show hidden parts. In this version "RET" toggles the visibility of any part which puts content in the buffer (as opposed to attachments such as application/pdf). The button is used to hide parts when appropriate (eg text/html in multipart/alternative).
2012-12-18 20:27:59 +01:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Part content ID handling
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
(defvar notmuch-show--cids nil
"Alist from raw content ID to (MSG PART).")
(make-variable-buffer-local 'notmuch-show--cids)
(defun notmuch-show--register-cids (msg part)
"Register content-IDs in PART and all of PART's sub-parts."
(let ((content-id (plist-get part :content-id)))
(when content-id
;; Note that content-IDs are globally unique, except when they
;; aren't: RFC 2046 section 5.1.4 permits children of a
;; multipart/alternative to have the same content-ID, in which
;; case the MUA is supposed to pick the best one it can render.
;; We simply add the content-ID to the beginning of our alist;
;; so if this happens, we'll take the last (and "best")
;; alternative (even if we can't render it).
(push (list content-id msg part) notmuch-show--cids)))
;; Recurse on sub-parts
emacs: avoid type errors due to nil as content-type The output of "notmuch show --format=sexp --format-version=4" may contain `:content-type' entries with `nil' as the value, when it fails to detect the correct value. Account for that in a few places where we would otherwise risk a type error. Note that `string=' does not choke on `nil' because it uses the `symbol-name' when encountering a symbol.
2021-01-10 19:47:22 +01:00
(when-let ((type (plist-get part :content-type)))
(pcase-let ((`(,type ,subtype)
(split-string (downcase type) "/")))
(cond ((equal type "multipart")
(mapc (apply-partially #'notmuch-show--register-cids msg)
(plist-get part :content)))
((and (equal type "message")
(equal subtype "rfc822"))
(notmuch-show--register-cids
msg
(car (plist-get (car (plist-get part :content)) :body))))))))
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
(defun notmuch-show--get-cid-content (cid)
"Return a list (CID-content content-type) or nil.
This will only find parts from messages that have been inserted
into the current buffer. CID must be a raw content ID, without
enclosing angle brackets, a cid: prefix, or URL encoding. This
will return nil if the CID is unknown or cannot be retrieved."
emacs: notmuch-show--get-cid-content: cosmetics
2021-01-10 19:47:21 +01:00
(when-let ((descriptor (cdr (assoc cid notmuch-show--cids))))
(pcase-let ((`(,msg ,part) descriptor))
;; Request caching for this content, as some messages
;; reference the same cid: part many times (hundreds!).
(list (notmuch-get-bodypart-binary
msg part notmuch-show-process-crypto 'cache)
(plist-get part :content-type)))))
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
(defun notmuch-show-setup-w3m ()
"Instruct w3m how to retrieve content from a \"related\" part of a message."
(interactive)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (and (boundp 'w3m-cid-retrieve-function-alist)
(not (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)))
(push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
w3m-cid-retrieve-function-alist))
emacs: Update integration with third party packages. `mm-inline-text-html-with-images' was removed from mm-decode.el in 2016 and replaced with `mm-html-inhibit-images'. `gnus-select-frame-set-input-focus' was removed from gnus-util.el in 2016 and existed only for XEmacs compatibility.
2018-10-04 11:45:45 +02:00
(setq mm-html-inhibit-images nil))
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
(defvar w3m-current-buffer) ;; From `w3m.el'.
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show--cid-w3m-retrieve (url &rest _args)
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
;; url includes the cid: prefix and is URL encoded (see RFC 2392).
(let* ((cid (url-unhex-string (substring url 4)))
(content-and-type
(with-current-buffer w3m-current-buffer
(notmuch-show--get-cid-content cid))))
(when content-and-type
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(insert (car content-and-type))
(cadr content-and-type))))
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
;; MIME part renderers
emacs: Add `notmuch-show-multipart/alternative-discouraged'. Also improved implementation of indication of which parts are not shown. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:03:08 +02:00
(defun notmuch-show-multipart/*-to-list (part)
Don't quote lambda forms This generates byte-compiler warnings on (at least) current trunk versions of Emacs. The quote is not necessary; lambda forms are self-quoting.
2011-12-17 16:47:48 +01:00
(mapcar (lambda (inner-part) (plist-get inner-part :content-type))
emacs: Add `notmuch-show-multipart/alternative-discouraged'. Also improved implementation of indication of which parts are not shown. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:03:08 +02:00
(plist-get part :content)))
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-multipart/alternative (msg part _content-type _nth depth _button)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(let ((chosen-type (car (notmuch-multipart/alternative-choose
msg (notmuch-show-multipart/*-to-list part))))
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
(inner-parts (plist-get part :content))
(start (point)))
emacs: Add `notmuch-show-multipart/alternative-discouraged'. Also improved implementation of indication of which parts are not shown. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:03:08 +02:00
;; This inserts all parts of the chosen type rather than just one,
;; but it's not clear that this is the wrong thing to do - which
;; should be chosen if there are more than one that match?
emacs: add more part handling functions This adds new notmuch-show-insert-part functions to handle multipart/alternative and message/rfc822 parts.
2011-05-13 08:09:30 +02:00
(mapc (lambda (inner-part)
emacs: show: add overlays for each part This makes notmuch-show-insert-bodypart add an overlay for any non-trivial part with a button header (currently the first text/plain part does not have a button). At this point the overlay is available to the button but there is no action using it yet. In addition the argument HIDE is passed down to notmuch-show-insert-part-overlays to request that the part be hidden by default but this is not acted on yet.
2012-12-18 20:27:58 +01:00
(let* ((inner-type (plist-get inner-part :content-type))
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
(hide (not (or notmuch-show-all-multipart/alternative-parts
(string= chosen-type inner-type)))))
emacs: show: add overlays for each part This makes notmuch-show-insert-bodypart add an overlay for any non-trivial part with a button header (currently the first text/plain part does not have a button). At this point the overlay is available to the button but there is no action using it yet. In addition the argument HIDE is passed down to notmuch-show-insert-part-overlays to request that the part be hidden by default but this is not acted on yet.
2012-12-18 20:27:58 +01:00
(notmuch-show-insert-bodypart msg inner-part depth hide)))
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
inner-parts)
(when notmuch-show-indent-multipart
emacs: Allow renderer of multipart/related parts access to non-primary parts. Typically used to allow a `text/html' renderer access to images which are sent along with the HTML. This is not enabled by default, instead the user must execute `notmuch-show-setup-w3m' for it to take effect. Edited-by: Carl Worth <cworth@cworth.org> Add documentation string for notmuch-show-setup-23m and clean up warning about reference/assignment of free variable. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:43:51 +02:00
(indent-rigidly start (point) 1)))
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-multipart/related (msg part _content-type _nth depth _button)
emacs: Allow renderer of multipart/related parts access to non-primary parts. Typically used to allow a `text/html' renderer access to images which are sent along with the HTML. This is not enabled by default, instead the user must execute `notmuch-show-setup-w3m' for it to take effect. Edited-by: Carl Worth <cworth@cworth.org> Add documentation string for notmuch-show-setup-23m and clean up warning about reference/assignment of free variable. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:43:51 +02:00
(let ((inner-parts (plist-get part :content))
(start (point)))
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
;; Render the primary part. FIXME: Support RFC 2387 Start header.
emacs: Allow renderer of multipart/related parts access to non-primary parts. Typically used to allow a `text/html' renderer access to images which are sent along with the HTML. This is not enabled by default, instead the user must execute `notmuch-show-setup-w3m' for it to take effect. Edited-by: Carl Worth <cworth@cworth.org> Add documentation string for notmuch-show-setup-23m and clean up warning about reference/assignment of free variable. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:43:51 +02:00
(notmuch-show-insert-bodypart msg (car inner-parts) depth)
emacs: add buttons for all multipart/related parts When text/html parts include images as multipart/related and the text/plain alternative is used these images can be completely hidden with no easy way to access them or even find out that they are there. Make notmuch-show-insert-part-multipart/related add buttons for all parts, the first one visible the rest hidden.
2013-08-16 22:24:23 +02:00
;; Add hidden buttons for the rest
(mapc (lambda (inner-part)
(notmuch-show-insert-bodypart msg inner-part depth t))
(cdr inner-parts))
emacs: Allow renderer of multipart/related parts access to non-primary parts. Typically used to allow a `text/html' renderer access to images which are sent along with the HTML. This is not enabled by default, instead the user must execute `notmuch-show-setup-w3m' for it to take effect. Edited-by: Carl Worth <cworth@cworth.org> Add documentation string for notmuch-show-setup-23m and clean up warning about reference/assignment of free variable. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-17 14:43:51 +02:00
(when notmuch-show-indent-multipart
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
(indent-rigidly start (point) 1)))
emacs: add more part handling functions This adds new notmuch-show-insert-part functions to handle multipart/alternative and message/rfc822 parts.
2011-05-13 08:09:30 +02:00
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-multipart/signed (msg part _content-type _nth depth button)
emacs/show: Accommodate the lack of part header buttons Various pieces of code assumed (reasonably) that part header buttons are present. Modify them to avoid problems if no part headers were inserted.
2016-02-20 19:24:37 +01:00
(when button
(button-put button 'face 'notmuch-crypto-part-header))
emacs: Always insert crypto buttons. When no decryption or signature examination is happening (i.e. `notmuch-crypto-process-mime' is `nil') insert buttons that indicate this, rather than remaining silent.
2016-04-03 17:38:22 +02:00
;; Insert a button detailing the signature status.
(notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
(notmuch-show-get-header :From msg))
emacs: Give mutlipart/{signed, encrypted} their own part handler. This is the best way to make the displayed output for decrypted/verified messages clearer. The special sigstatus and encstatus buttons are now displayed under the part header button. The part header button is also tweaked to provide information to user about how to proces crypto.
2011-05-27 20:52:19 +02:00
(let ((inner-parts (plist-get part :content))
(start (point)))
;; Show all of the parts.
(mapc (lambda (inner-part)
(notmuch-show-insert-bodypart msg inner-part depth))
inner-parts)
(when notmuch-show-indent-multipart
(indent-rigidly start (point) 1)))
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-multipart/encrypted (msg part _content-type _nth depth button)
emacs/show: Accommodate the lack of part header buttons Various pieces of code assumed (reasonably) that part header buttons are present. Modify them to avoid problems if no part headers were inserted.
2016-02-20 19:24:37 +01:00
(when button
(button-put button 'face 'notmuch-crypto-part-header))
emacs: Always insert crypto buttons. When no decryption or signature examination is happening (i.e. `notmuch-crypto-process-mime' is `nil') insert buttons that indicate this, rather than remaining silent.
2016-04-03 17:38:22 +02:00
;; Insert a button detailing the encryption status.
(notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
;; Insert a button detailing the signature status.
(notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
(notmuch-show-get-header :From msg))
emacs: Give mutlipart/{signed, encrypted} their own part handler. This is the best way to make the displayed output for decrypted/verified messages clearer. The special sigstatus and encstatus buttons are now displayed under the part header button. The part header button is also tweaked to provide information to user about how to proces crypto.
2011-05-27 20:52:19 +02:00
(let ((inner-parts (plist-get part :content))
(start (point)))
;; Show all of the parts.
(mapc (lambda (inner-part)
(notmuch-show-insert-bodypart msg inner-part depth))
inner-parts)
(when notmuch-show-indent-multipart
(indent-rigidly start (point) 1)))
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-application/pgp-encrypted (_msg _part _content-type _nth _depth _button)
emacs: reply: remove wrong sig/enc status buttons This stops the (usually incorrect) sigstatus and encstatus buttons appearing when replying in emacs, and updates the test suite to match. Overriding the status button functions is a little unusual but much less intrusive than passing an argument all the way down the call chain. It also makes it clear exactly what it does. We also hide the application/pgp-encrypted part as it can only contain "Version: 1". We do this in notmuch show, which means it also happens when replying.
2016-09-13 03:45:58 +02:00
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-multipart/* (msg part _content-type _nth depth _button)
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
(let ((inner-parts (plist-get part :content))
(start (point)))
notmuch show: Properly nest MIME parts within mulipart parts Previously, notmuch show flattened all output, losing information about the nesting of the MIME hierarchy. Now, the output is properly nested, (both in the --format=text and --format=json output), so that clients can analyze the original MIME structure. Internally, this required splitting the final closing delimiter out of the various show_part functions and putting it into a new show_part_end function instead. Also, the show_part function now accepts a new "first" argument that is set not only for the first MIME part of a message, but also for each first MIME part within a series of multipart parts. This "first" argument controls the omission of a preceding comma when printing a part (for json). Many thanks to David Edmondson <dme@dme.org> for originally identifying the lack of nesting in the json output and submitting an early implementation of this feature. Thanks as well to Jameson Graef Rollins <jrollins@finestructure.net> for carefully shepherding David's patches through a remarkably long review process, patiently explaining them, and providing a cleaned up series that led to this final implementation. Jameson also provided the new emacs code here.
2011-05-18 00:34:57 +02:00
;; Show all of the parts.
(mapc (lambda (inner-part)
(notmuch-show-insert-bodypart msg inner-part depth))
emacs: Allow indentation of multipart children. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-10 12:15:30 +02:00
inner-parts)
(when notmuch-show-indent-multipart
(indent-rigidly start (point) 1)))
notmuch show: Properly nest MIME parts within mulipart parts Previously, notmuch show flattened all output, losing information about the nesting of the MIME hierarchy. Now, the output is properly nested, (both in the --format=text and --format=json output), so that clients can analyze the original MIME structure. Internally, this required splitting the final closing delimiter out of the various show_part functions and putting it into a new show_part_end function instead. Also, the show_part function now accepts a new "first" argument that is set not only for the first MIME part of a message, but also for each first MIME part within a series of multipart parts. This "first" argument controls the omission of a preceding comma when printing a part (for json). Many thanks to David Edmondson <dme@dme.org> for originally identifying the lack of nesting in the json output and submitting an early implementation of this feature. Thanks as well to Jameson Graef Rollins <jrollins@finestructure.net> for carefully shepherding David's patches through a remarkably long review process, patiently explaining them, and providing a cleaned up series that led to this final implementation. Jameson also provided the new emacs code here.
2011-05-18 00:34:57 +02:00
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-message/rfc822 (msg part _content-type _nth depth _button)
emacs: don't inline message/rfc822 parts without content This avoids some ugly error messages and exceptions, and hopes that some gnus method will display message/rfc822 parts that have only a file, no :content part.
2021-07-04 15:16:38 +02:00
(let ((message (car (plist-get part :content))))
(and
message
(let ((body (car (plist-get message :body)))
(start (point)))
;; Override `notmuch-message-headers' to force `From' to be
;; displayed.
(let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
(notmuch-show-insert-headers (plist-get message :headers)))
;; Blank line after headers to be compatible with the normal
;; message display.
(insert "\n")
;; Show the body
(notmuch-show-insert-bodypart msg body depth)
(when notmuch-show-indent-multipart
(indent-rigidly start (point) 1))
t))))
emacs: add more part handling functions This adds new notmuch-show-insert-part functions to handle multipart/alternative and message/rfc822 parts.
2011-05-13 08:09:30 +02:00
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-text/plain (msg part _content-type _nth depth button)
emacs: show: move the insertion of the header button to the top level Previously each of the part insertion handlers inserted the part button themselves. Move this up into notmuch-show-insert-bodypart. Since a small number of the handlers modify the button (the encryption/signature ones) we need to pass the header button as an argument into the individual part insertion handlers. However, the declared-type argument was only used for the text for the part buttons we can now omit it. The patch is large but mostly simple. The only things of note are that we let the text/plain handler applies notmuch-wash to the whole part including the part button. In particular, notmuch-wash removes leading blank lines from a text/plain part, but since the button is counted as part of the part this does not happen with text/plain buttons that have a button. This is probably a bug in notmuch-wash but changing it does make several tests fail (that rely on this blank line) so, for the moment, keep the old behaviour.
2013-06-10 06:57:09 +02:00
;; For backward compatibility we want to apply the text/plain hook
;; to the whole of the part including the part button if there is
;; one.
(let ((start (if button
(button-start button)
(point))))
emacs: Remove broken `notmuch-get-bodypart-content' API `notmuch-get-bodypart-content' could do two very different things, depending on conditions: for text/* parts other than text/html, it would return the part content as a multibyte Lisp string *after* charset conversion, while for other parts (including text/html), it would return binary part content without charset conversion. This commit completes the split of `notmuch-get-bodypart-content' into two different and explicit APIs: `notmuch-get-bodypart-binary' and `notmuch-get-bodypart-text'. It updates all callers to use one or the other depending on what's appropriate.
2015-01-24 22:16:58 +01:00
(insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(save-excursion
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(save-restriction
(narrow-to-region start (point-max))
Pass message to the `notmuch-show-insert-text/plain-hook' hook. Before the change, the `notmuch-show-insert-text/plain-hook' was given only the `depth' argument. The patch adds another one - the message. Currently, the new message argument is not used by any on the hooks. But it will be used later to get access to message invisibility specs when wash buttons are inserted.
2011-05-26 00:10:12 +02:00
(run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
t)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-text/calendar (msg part _content-type _nth _depth _button)
emacs: Render text/x-vcalendar parts. Use code from icalendar.el to convert text/x-vcalendar parts to something suitable for use with the Emacs diary. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-12 10:07:49 +02:00
(insert (with-temp-buffer
emacs: Remove broken `notmuch-get-bodypart-content' API `notmuch-get-bodypart-content' could do two very different things, depending on conditions: for text/* parts other than text/html, it would return the part content as a multibyte Lisp string *after* charset conversion, while for other parts (including text/html), it would return binary part content without charset conversion. This commit completes the split of `notmuch-get-bodypart-content' into two different and explicit APIs: `notmuch-get-bodypart-binary' and `notmuch-get-bodypart-text'. It updates all callers to use one or the other depending on what's appropriate.
2015-01-24 22:16:58 +01:00
(insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
;; notmuch-get-bodypart-text does no newline conversion.
;; Replace CRLF with LF before icalendar can use it.
emacs: Render text/x-vcalendar parts. Use code from icalendar.el to convert text/x-vcalendar parts to something suitable for use with the Emacs diary. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-12 10:07:49 +02:00
(goto-char (point-min))
notmuch-show.el: import calendar data with public function after CR removal notmuch-get-bodypart-content provides raw data to its caller so that it can be stored verbatim whenever needed. icalendar functions expect Emacs to do EOL conversion for the data given to these. Therefore it the CRLF -> LF conversion is now done explicitly. The calls to private functions icalendar--convert-ical-to-diary and icalendar--read-element are replaced with call to public function icalendar-import-buffer.
2012-11-08 13:07:59 +01:00
(while (re-search-forward "\r\n" nil t)
(replace-match "\n" nil nil))
emacs: Render text/x-vcalendar parts. Use code from icalendar.el to convert text/x-vcalendar parts to something suitable for use with the Emacs diary. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-12 10:07:49 +02:00
(let ((file (make-temp-file "notmuch-ical"))
result)
notmuch-show.el: handle the case where icalendar-import-buffer returns nil icalendar-import-buffer can fail by an error signal (which have been witnessed) but according to its docstring it can also return nil when failing (it returns t when succeeding). Now that the error is caught by the caller of notmuch-show-inset-part-* functions in case icalendar-import-buffer returns nil an explicit error is signaled and unwind-protect takes care of deleting the temporary file (just in case, it is usually not written to the fs yet).
2012-11-08 13:08:00 +01:00
(unwind-protect
(progn
(unless (icalendar-import-buffer file t)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(error "Icalendar import error. %s"
"See *icalendar-errors* for more information"))
notmuch-show.el: handle the case where icalendar-import-buffer returns nil icalendar-import-buffer can fail by an error signal (which have been witnessed) but according to its docstring it can also return nil when failing (it returns t when succeeding). Now that the error is caught by the caller of notmuch-show-inset-part-* functions in case icalendar-import-buffer returns nil an explicit error is signaled and unwind-protect takes care of deleting the temporary file (just in case, it is usually not written to the fs yet).
2012-11-08 13:08:00 +01:00
(set-buffer (get-file-buffer file))
(setq result (buffer-substring (point-min) (point-max)))
(set-buffer-modified-p nil)
(kill-buffer (current-buffer)))
(delete-file file))
emacs: Render text/x-vcalendar parts. Use code from icalendar.el to convert text/x-vcalendar parts to something suitable for use with the Emacs diary. Signed-off-by: Jameson Rollins <jrollins@finestructure.net>
2010-05-12 10:07:49 +02:00
result)))
t)
emacs: support text/calendar mime type Replace text/x-vcalendar with text/calendar, while maintaining support and backwards compatibility for text/x-vcalendar. Code by David Edmondson <dme@dme.org>
2012-02-09 15:46:03 +01:00
;; For backwards compatibility.
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-text/x-vcalendar (msg part _content-type _nth depth _button)
(notmuch-show-insert-part-text/calendar msg part nil nil depth nil))
emacs: support text/calendar mime type Replace text/x-vcalendar with text/calendar, while maintaining support and backwards compatibility for text/x-vcalendar. Code by David Edmondson <dme@dme.org>
2012-02-09 15:46:03 +01:00
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (version< emacs-version "25.3")
;; https://bugs.gnu.org/28350
;;
;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
;; (see notmuch-show-handlers-for)
(defun notmuch-show-insert-part-text/enriched
(msg part content-type nth depth button)
;; By requiring enriched below, we ensure that the function
;; enriched-decode-display-prop is defined before it will be
;; shadowed by the letf below. Otherwise the version in
;; enriched.el may be loaded a bit later and used instead (for
;; the first time).
(require 'enriched)
(cl-letf (((symbol-function 'enriched-decode-display-prop)
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(lambda (start end &optional _param) (list start end))))
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(notmuch-show-insert-part-*/* msg part content-type nth depth button))))
emacs: override enriched-decode-display-prop for text/enriched display Switch to a local version of enriched-decode-display-prop if we encounter a text/enriched part. This is to mitigate https://bugs.gnu.org/28350. Normally it would be prudent to remove the override afterwards, but in this case just leave it in. Notes from db: This doesn't disable text/enriched, just one feature of it.
2017-09-11 22:09:49 +02:00
emacs:show: separate out handling of application/octet-stream Currently mime parts are basically handled based on their mime-type with the exception of application/octet-stream parts. Deal with these parts at the top level (notmuch-show-insert-bodypart). This is needed later in the series as we need to put in a part button for each part (which means knowing its mime type) while deferring the actual insertion of the part.
2013-05-04 15:01:14 +02:00
(defun notmuch-show-get-mime-type-of-application/octet-stream (part)
emacs: Use mailcap.el to guess the type of application/octet-stream parts Use the mailcap functionality to guess a MIME type for attachments of type application/octet-stream and, presuming successful, feed the attachment back into the display code with the determine type. This is mostly useless at the moment, as the JSON output from notmuch does not include the content of application/octet-stream parts, so they cannot be displayed even if the guess is a good one.
2010-03-23 12:54:05 +01:00
;; If we can deduce a MIME type from the filename of the attachment,
emacs:show: separate out handling of application/octet-stream Currently mime parts are basically handled based on their mime-type with the exception of application/octet-stream parts. Deal with these parts at the top level (notmuch-show-insert-bodypart). This is needed later in the series as we need to put in a part button for each part (which means knowing its mime type) while deferring the actual insertion of the part.
2013-05-04 15:01:14 +02:00
;; we return that.
emacs: Use 'and' instead of 'when' when the return value matters Also do so for some 'if' forms that lack an ELSE part. Even go as far as using 'and' and 'not' instead of 'unless'.
2020-08-08 13:49:41 +02:00
(and (plist-get part :filename)
(let ((extension (file-name-extension (plist-get part :filename))))
(and extension
(progn
(mailcap-parse-mimetypes)
(let ((mime-type (mailcap-extension-to-mime extension)))
(and mime-type
(not (string-equal mime-type "application/octet-stream"))
mime-type)))))))
emacs: Use mailcap.el to guess the type of application/octet-stream parts Use the mailcap functionality to guess a MIME type for attachments of type application/octet-stream and, presuming successful, feed the attachment back into the display code with the determine type. This is mostly useless at the moment, as the JSON output from notmuch does not include the content of application/octet-stream parts, so they cannot be displayed even if the guess is a good one.
2010-03-23 12:54:05 +01:00
emacs: show: move the insertion of the header button to the top level Previously each of the part insertion handlers inserted the part button themselves. Move this up into notmuch-show-insert-bodypart. Since a small number of the handlers modify the button (the encryption/signature ones) we need to pass the header button as an argument into the individual part insertion handlers. However, the declared-type argument was only used for the text for the part buttons we can now omit it. The patch is large but mostly simple. The only things of note are that we let the text/plain handler applies notmuch-wash to the whole part including the part button. In particular, notmuch-wash removes leading blank lines from a text/plain part, but since the button is counted as part of the part this does not happen with text/plain buttons that have a button. This is probably a bug in notmuch-wash but changing it does make several tests fail (that rely on this blank line) so, for the moment, keep the old behaviour.
2013-06-10 06:57:09 +02:00
(defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
emacs: Support cid: references with shr renderer shr has really nice support for inline image rendering, but previously we only had the hooks for w3m cid: references.
2015-01-24 22:17:03 +01:00
(if (eq mm-text-html-renderer 'shr)
;; It's easier to drive shr ourselves than to work around the
;; goofy things `mm-shr' does (like irreversibly taking over
;; content ID handling).
emacs: Add a defcustom that specifies regexp for blocked remote images. It's default value is ".", meaning all remote images will be blocked by default.
2015-02-02 22:04:52 +01:00
;; FIXME: If we block an image, offer a button to load external
;; images.
(let ((shr-blocked-images notmuch-show-text/html-blocked-images))
(notmuch-show--insert-part-text/html-shr msg part))
emacs: Support cid: references with shr renderer shr has really nice support for inline image rendering, but previously we only had the hooks for w3m cid: references.
2015-01-24 22:17:03 +01:00
;; Otherwise, let message-mode do the heavy lifting
;;
;; w3m sets up a keymap which "leaks" outside the invisible region
;; and causes strange effects in notmuch. We set
;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
;; set a keymap (so the normal notmuch-show-mode-map remains).
emacs: Add a defcustom that specifies regexp for blocked remote images. It's default value is ".", meaning all remote images will be blocked by default.
2015-02-02 22:04:52 +01:00
(let ((mm-inline-text-html-with-w3m-keymap nil)
;; FIXME: If we block an image, offer a button to load external
;; images.
emacs: honour notmuch-show-text/html-blocked-images in w3m messages When mm-text-html-renderer is set to 'w3m, the variable playing the role of a regular expression for blocked images is w3m-ignored-image-url-regexp. We bind it when the renderer is not 'shr.
2021-08-04 02:02:41 +02:00
(gnus-blocked-images notmuch-show-text/html-blocked-images)
(w3m-ignored-image-url-regexp notmuch-show-text/html-blocked-images))
emacs: Support cid: references with shr renderer shr has really nice support for inline image rendering, but previously we only had the hooks for w3m cid: references.
2015-01-24 22:17:03 +01:00
(notmuch-show-insert-part-*/* msg part content-type nth depth button))))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Functions used by notmuch-show--insert-part-text/html-shr
emacs: Support cid: references with shr renderer shr has really nice support for inline image rendering, but previously we only had the hooks for w3m cid: references.
2015-01-24 22:17:03 +01:00
(declare-function libxml-parse-html-region "xml.c")
(declare-function shr-insert-document "shr")
(defun notmuch-show--insert-part-text/html-shr (msg part)
;; Make sure shr is loaded before we start let-binding its globals
(require 'shr)
(let ((dom (let ((process-crypto notmuch-show-process-crypto))
(with-temp-buffer
(insert (notmuch-get-bodypart-text msg part process-crypto))
(libxml-parse-html-region (point-min) (point-max)))))
(shr-content-function
(lambda (url)
;; shr strips the "cid:" part of URL, but doesn't
;; URL-decode it (see RFC 2392).
(let ((cid (url-unhex-string url)))
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(car (notmuch-show--get-cid-content cid))))))
emacs: Support cid: references with shr renderer shr has really nice support for inline image rendering, but previously we only had the hooks for w3m cid: references.
2015-01-24 22:17:03 +01:00
(shr-insert-document dom)
t))
emacs: show: w3m/invisibility workaround There is a bug in the current notmuch code with w3m and invisible parts. w3m sets a keymap, and if we have a hidden [text/html] point at the start of the following line still gets this w3m keymap which causes some strange effects. For example, RET gives an error "No URL at Point" rather than hiding the message, <down> goes to the next link rather than just down a line. These keybinding are also inconvenient when the text/html part is displayed so we ask w3m not to install a keymap. This is only likely to be a problem for emacs 23 as shr is preferred as html renderer on emacs 24 (although the user can set the renderer to w3m even on emacs 24). This solution was suggested by Tomi Ollila <tomi.ollila@iki.fi>
2013-01-13 13:43:52 +01:00
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-part-*/* (msg part content-type _nth _depth _button)
emacs: Display all body parts using `notmuch part --part=<n>' Use the `notmuch part' command to access body parts not currently included in the JSON output and display those body parts appropriately.
2010-04-01 19:33:46 +02:00
;; This handler _must_ succeed - it is the handler of last resort.
emacs: Remove redundant NTH argument from `notmuch-get-bodypart-content'. This can be derived from the PART argument (which is arguably canonical), so there's no sense in giving the caller an extra foot gun.
2014-04-21 20:37:38 +02:00
(notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
t)
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Functions for determining how to handle MIME parts.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-handlers-for (content-type)
"Return a list of content handlers for a part of type CONTENT-TYPE."
(let (result)
(mapc (lambda (func)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (functionp func)
(push func result)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; Reverse order of prefrence.
(list (intern (concat "notmuch-show-insert-part-*/*"))
emacs: inline notmuch-split-content-type This trivial helper function actually made things slightly *less* readable by adding an unnecessary indirection.
2020-11-16 22:28:37 +01:00
(intern (concat "notmuch-show-insert-part-"
(car (split-string content-type "/"))
"/*"))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(intern (concat "notmuch-show-insert-part-" content-type))))
result))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Parts
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: show: move the insertion of the header button to the top level Previously each of the part insertion handlers inserted the part button themselves. Move this up into notmuch-show-insert-bodypart. Since a small number of the handlers modify the button (the encryption/signature ones) we need to pass the header button as an argument into the individual part insertion handlers. However, the declared-type argument was only used for the text for the part buttons we can now omit it. The patch is large but mostly simple. The only things of note are that we let the text/plain handler applies notmuch-wash to the whole part including the part button. In particular, notmuch-wash removes leading blank lines from a text/plain part, but since the button is counted as part of the part this does not happen with text/plain buttons that have a button. This is probably a bug in notmuch-wash but changing it does make several tests fail (that rely on this blank line) so, for the moment, keep the old behaviour.
2013-06-10 06:57:09 +02:00
(defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
emacs: Neaten `notmuch-show-insert-bodypart-internal'.
2016-03-08 18:12:58 +01:00
;; Run the handlers until one of them succeeds.
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(cl-loop for handler in (notmuch-show-handlers-for content-type)
until (condition-case err
(funcall handler msg part content-type nth depth button)
;; Specifying `debug' here lets the debugger run if
;; `debug-on-error' is non-nil.
((debug error)
(insert "!!! Bodypart handler `" (prin1-to-string handler)
"' threw an error:\n"
"!!! " (error-message-string err) "\n")
nil))))
emacs: Use mailcap.el to guess the type of application/octet-stream parts Use the mailcap functionality to guess a MIME type for attachments of type application/octet-stream and, presuming successful, feed the attachment back into the display code with the determine type. This is mostly useless at the moment, as the JSON output from notmuch does not include the content of application/octet-stream parts, so they cannot be displayed even if the guess is a good one.
2010-03-23 12:54:05 +01:00
emacs: show: modify the way hidden state is recorded. Previously, whether a part was hidden or shown was recorded in the invisibility/visibility of the part overlay. Since we are going to have lazily rendered parts with no overlay store the hidden/shown state in the part button itself. Additionally, in preparation for the invisible part handling move the actual hiding of the hidden parts to insert-bodypart from create-part-overlays. Finally, we will need to know whether a part-insertion has done anything (it won't if the invisible part cannot be displayed by emacs) so we slightly rejig the code order in notmuch-show-toggle-part-invisibility to make it easier for the function to set an appropriate return value.
2013-06-10 06:57:11 +02:00
(defun notmuch-show-create-part-overlays (button beg end)
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Add an overlay to the part between BEG and END."
emacs: show: pass button to create-overlays Now that the bodypart code has the button we can pass that to create-overlays and simplify that.
2013-06-10 06:57:10 +02:00
;; If there is no button (i.e., the part is text/plain and the first
;; part) or if the part has no content then we don't make the part
;; toggleable.
(when (and button (/= beg end))
(button-put button 'overlay (make-overlay beg end))
emacs: show: modify the way hidden state is recorded. Previously, whether a part was hidden or shown was recorded in the invisibility/visibility of the part overlay. Since we are going to have lazily rendered parts with no overlay store the hidden/shown state in the part button itself. Additionally, in preparation for the invisible part handling move the actual hiding of the hidden parts to insert-bodypart from create-part-overlays. Finally, we will need to know whether a part-insertion has done anything (it won't if the invisible part cannot be displayed by emacs) so we slightly rejig the code order in notmuch-show-toggle-part-invisibility to make it easier for the function to set an appropriate return value.
2013-06-10 06:57:11 +02:00
;; Return true if we created an overlay.
t))
emacs: show: add overlays for each part This makes notmuch-show-insert-bodypart add an overlay for any non-trivial part with a button header (currently the first text/plain part does not have a button). At this point the overlay is available to the button but there is no action using it yet. In addition the argument HIDE is passed down to notmuch-show-insert-part-overlays to request that the part be hidden by default but this is not acted on yet.
2012-12-18 20:27:58 +01:00
emacs: show move addition of :notmuch-part to separate function This separates out the adding of the :notmuch-part text property to a separate function to simplify calling from the lazy part insertion code.
2013-06-10 06:57:12 +02:00
(defun notmuch-show-record-part-information (part beg end)
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Store PART as a text property from BEG to END."
emacs: show move addition of :notmuch-part to separate function This separates out the adding of the :notmuch-part text property to a separate function to simplify calling from the lazy part insertion code.
2013-06-10 06:57:12 +02:00
;; Record part information. Since we already inserted subparts,
;; don't override existing :notmuch-part properties.
(notmuch-map-text-property beg end :notmuch-part
(lambda (v) (or v part)))
;; Make :notmuch-part front sticky and rear non-sticky so it stays
;; applied to the beginning of each line when we indent the
;; message. Since we're operating on arbitrary renderer output,
;; watch out for sticky specs of t, which means all properties are
;; front-sticky/rear-nonsticky.
(notmuch-map-text-property beg end 'front-sticky
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(lambda (v)
(if (listp v)
(cl-pushnew :notmuch-part v)
v)))
emacs: show move addition of :notmuch-part to separate function This separates out the adding of the :notmuch-part text property to a separate function to simplify calling from the lazy part insertion code.
2013-06-10 06:57:12 +02:00
(notmuch-map-text-property beg end 'rear-nonsticky
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(lambda (v)
(if (listp v)
(cl-pushnew :notmuch-part v)
v))))
emacs: show move addition of :notmuch-part to separate function This separates out the adding of the :notmuch-part text property to a separate function to simplify calling from the lazy part insertion code.
2013-06-10 06:57:12 +02:00
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
(defun notmuch-show-lazy-part (part-args button)
;; Insert the lazy part after the button for the part. We would just
;; move to the start of the new line following the button and insert
;; the part but that point might have text properties (eg colours
;; from a message header etc) so instead we start from the last
;; character of the button by adding a newline and finish by
;; removing the extra newline from the end of the part.
(save-excursion
(goto-char (button-end button))
(insert "\n")
(let* ((inhibit-read-only t)
;; We need to use markers for the start and end of the part
;; because the part insertion functions do not guarantee
;; to leave point at the end of the part.
(part-beg (copy-marker (point) nil))
(part-end (copy-marker (point) t))
;; We have to save the depth as we can't find the depth
;; when narrowed.
emacs/show: save redisplay redisplay data when showing lazy part. This data will be used to redisplay an image that is hidden by deleting it from the buffer. We cannot easily delay until the image is hidden, as we won't have the original data at that point.
2023-09-24 11:51:50 +02:00
(depth (notmuch-show-get-depth))
(mime-type (plist-get (cadr part-args) :computed-type)))
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
(save-restriction
(narrow-to-region part-beg part-end)
(delete-region part-beg part-end)
emacs/show: save redisplay redisplay data when showing lazy part. This data will be used to redisplay an image that is hidden by deleting it from the buffer. We cannot easily delay until the image is hidden, as we won't have the original data at that point.
2023-09-24 11:51:50 +02:00
(when (and mime-type (string-match "^image/" mime-type))
(button-put button :notmuch-redisplay-data part-args))
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
(apply #'notmuch-show-insert-bodypart-internal part-args)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(indent-rigidly part-beg
part-end
(* notmuch-show-indent-messages-width depth)))
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
(goto-char part-end)
(delete-char 1)
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(notmuch-show-record-part-information (cadr part-args)
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
(button-start button)
part-end)
;; Create the overlay. If the lazy-part turned out to be empty/not
;; showable this returns nil.
(notmuch-show-create-part-overlays button part-beg part-end))))
emacs/show: Re-arrange determination if a part header is necessary Move the determination of whether a part header is required to a distinct function.
2016-02-20 19:24:35 +01:00
(defun notmuch-show-mime-type (part)
"Return the correct mime-type to use for PART."
emacs: avoid type errors due to nil as content-type The output of "notmuch show --format=sexp --format-version=4" may contain `:content-type' entries with `nil' as the value, when it fails to detect the correct value. Account for that in a few places where we would otherwise risk a type error. Note that `string=' does not choke on `nil' because it uses the `symbol-name' when encountering a symbol.
2021-01-10 19:47:22 +01:00
(when-let ((content-type (plist-get part :content-type)))
(setq content-type (downcase content-type))
emacs/show: Re-arrange determination if a part header is necessary Move the determination of whether a part header is required to a distinct function.
2016-02-20 19:24:35 +01:00
(or (and (string= content-type "application/octet-stream")
(notmuch-show-get-mime-type-of-application/octet-stream part))
(and (string= content-type "inline patch")
"text/x-diff")
content-type)))
emacs/show: Make the insertion of part headers overridable. This allows callers of notmuch-show-insert-bodypart to use a `let' binding to override the default function for specifying when part headers should be inserted. We also add an option to never show part buttons which will be used by the test suites for the reply tests.
2016-02-20 19:24:36 +01:00
;; The following variable can be overridden by let bindings.
(defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
"Specify which function decides which part headers get inserted.
The function should take two parameters, PART and HIDE, and
should return non-NIL if a header button should be inserted for
this part.")
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-insert-header-p (part _hide)
emacs/show: Re-arrange determination if a part header is necessary Move the determination of whether a part header is required to a distinct function.
2016-02-20 19:24:35 +01:00
;; Show all part buttons except for the first part if it is text/plain.
(let ((mime-type (notmuch-show-mime-type part)))
(not (and (string= mime-type "text/plain")
(<= (plist-get part :id) 1)))))
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-reply-insert-header-p-never (_part _hide)
emacs/show: Make the insertion of part headers overridable. This allows callers of notmuch-show-insert-bodypart to use a `let' binding to override the default function for specifying when part headers should be inserted. We also add an option to never show part buttons which will be used by the test suites for the reply tests.
2016-02-20 19:24:36 +01:00
nil)
emacs/mua: Let user specify which parts get a header in citations. Add a customizable function specifying which parts get a header when replying, and give some sensible possiblities. These are, 1) all parts except multipart/*. (Subparts of a multipart part do receive a header button.) 2) only included text/* parts. 3) Exactly as in the show buffer. 4) None at all. This means the reply contains a mish-mash of all the original message's parts. In the test suite we set the choice to option 4 to match the previous behaviour.
2016-02-20 19:24:40 +01:00
(defun notmuch-show-reply-insert-header-p-trimmed (part hide)
(let ((mime-type (notmuch-show-mime-type part)))
(and (not (notmuch-match-content-type mime-type "multipart/*"))
(not hide))))
(defun notmuch-show-reply-insert-header-p-minimal (part hide)
(let ((mime-type (notmuch-show-mime-type part)))
(and (notmuch-match-content-type mime-type "text/*")
(not hide))))
emacs: show: add overlays for each part This makes notmuch-show-insert-bodypart add an overlay for any non-trivial part with a button header (currently the first text/plain part does not have a button). At this point the overlay is available to the button but there is no action using it yet. In addition the argument HIDE is passed down to notmuch-show-insert-part-overlays to request that the part be hidden by default but this is not acted on yet.
2012-12-18 20:27:58 +01:00
(defun notmuch-show-insert-bodypart (msg part depth &optional hide)
"Insert the body part PART at depth DEPTH in the current thread.
emacs: insert quotable parts in reply as they are displayed in show view In reply, insert quotable parts using notmuch-show-insert-bodypart instead of calling notmuch-mm-display-part-inline directly to render the quoted parts as they are rendered in show view. We use a temp buffer to not leak text properties from the show renderer into the reply. This way we also don't need to worry about narrowing or point placement. Credits to Mark Walters <markwalters1009@gmail.com> and Austin Clements <amdragon@MIT.EDU> for getting this part straight. The notable change is that replies to text/calendar parts quote the pretty printed output of icalendar-import-buffer rather than the ugly raw vcalendar.
2013-09-01 19:59:53 +02:00
HIDE determines whether to show or hide the part and the button
as follows: If HIDE is nil, show the part and the button. If HIDE
emacs/show: Remove the 'no-buttons option of `notmuch-show-insert-bodypart' No code uses the 'no-buttons argument to `notmuch-show-insert-bodypart', so remove it.
2016-02-20 19:24:39 +01:00
is t, hide the part initially and show the button."
emacs: avoid type errors due to nil as content-type The output of "notmuch show --format=sexp --format-version=4" may contain `:content-type' entries with `nil' as the value, when it fails to detect the correct value. Account for that in a few places where we would otherwise risk a type error. Note that `string=' does not choke on `nil' because it uses the `symbol-name' when encountering a symbol.
2021-01-10 19:47:22 +01:00
(let* ((content-type (plist-get part :content-type))
emacs/show: Re-arrange determination if a part header is necessary Move the determination of whether a part header is required to a distinct function.
2016-02-20 19:24:35 +01:00
(mime-type (notmuch-show-mime-type part))
emacs:show: separate out handling of application/octet-stream Currently mime parts are basically handled based on their mime-type with the exception of application/octet-stream parts. Deal with these parts at the top level (notmuch-show-insert-bodypart). This is needed later in the series as we need to put in a part button for each part (which means knowing its mime type) while deferring the actual insertion of the part.
2013-05-04 15:01:14 +02:00
(nth (plist-get part :id))
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(height (plist-get msg :height))
emacs: show: hide large text attachments by default notmuch-show can be slow displaying large attachments so hide them by default. The default maximum size is 10000 bytes/characters but it is customizable. Note that notmuch-show-insert-bodypart is also called from the reply code so we need to be a little careful.
2015-03-28 12:08:59 +01:00
(long (and (notmuch-match-content-type mime-type "text/*")
(> notmuch-show-max-text-part-size 0)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(> (length (plist-get part :content))
notmuch-show-max-text-part-size)))
emacs/show: optionally insert bodies of "deep messages" lazily This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-06-28 03:02:02 +02:00
(deep (and notmuch-show-depth-limit
(> depth notmuch-show-depth-limit)))
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(high (and notmuch-show-height-limit
(> height notmuch-show-height-limit)))
emacs: show: move the insertion of the header button to the top level Previously each of the part insertion handlers inserted the part button themselves. Move this up into notmuch-show-insert-bodypart. Since a small number of the handlers modify the button (the encryption/signature ones) we need to pass the header button as an argument into the individual part insertion handlers. However, the declared-type argument was only used for the text for the part buttons we can now omit it. The patch is large but mostly simple. The only things of note are that we let the text/plain handler applies notmuch-wash to the whole part including the part button. In particular, notmuch-wash removes leading blank lines from a text/plain part, but since the button is counted as part of the part this does not happen with text/plain buttons that have a button. This is probably a bug in notmuch-wash but changing it does make several tests fail (that rely on this blank line) so, for the moment, keep the old behaviour.
2013-06-10 06:57:09 +02:00
(beg (point))
emacs/show: Make the insertion of part headers overridable. This allows callers of notmuch-show-insert-bodypart to use a `let' binding to override the default function for specifying when part headers should be inserted. We also add an option to never show part buttons which will be used by the test suites for the reply tests.
2016-02-20 19:24:36 +01:00
;; This default header-p function omits the part button for
;; the first (or only) part if this is text/plain.
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(button (and (or deep long high
emacs/show: optionally insert bodies of "deep messages" lazily This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-06-28 03:02:02 +02:00
(funcall notmuch-show-insert-header-p-function part hide))
emacs: Use 'and' instead of 'when' when the return value matters Also do so for some 'if' forms that lack an ELSE part. Even go as far as using 'and' and 'not' instead of 'unless'.
2020-08-08 13:49:41 +02:00
(notmuch-show-insert-part-header
emacs: avoid type errors due to nil as content-type The output of "notmuch show --format=sexp --format-version=4" may contain `:content-type' entries with `nil' as the value, when it fails to detect the correct value. Account for that in a few places where we would otherwise risk a type error. Note that `string=' does not choke on `nil' because it uses the `symbol-name' when encountering a symbol.
2021-01-10 19:47:22 +01:00
nth mime-type
(and content-type (downcase content-type))
emacs: Use 'and' instead of 'when' when the return value matters Also do so for some 'if' forms that lack an ELSE part. Even go as far as using 'and' and 'not' instead of 'unless'.
2020-08-08 13:49:41 +02:00
(plist-get part :filename))))
emacs/show: optionally insert bodies of "deep messages" lazily This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-06-28 03:02:02 +02:00
;; Hide the part initially if HIDE is t, or if it is too long/deep
emacs/show: Remove the 'no-buttons option of `notmuch-show-insert-bodypart' No code uses the 'no-buttons argument to `notmuch-show-insert-bodypart', so remove it.
2016-02-20 19:24:39 +01:00
;; and we have a button to allow toggling.
emacs: show: hide large text attachments by default notmuch-show can be slow displaying large attachments so hide them by default. The default maximum size is 10000 bytes/characters but it is customizable. Note that notmuch-show-insert-bodypart is also called from the reply code so we need to be a little careful.
2015-03-28 12:08:59 +01:00
(show-part (not (or (equal hide t)
emacs/show: optionally insert bodies of "deep messages" lazily This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-06-28 03:02:02 +02:00
(and deep button)
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(and high button)
emacs: show: hide large text attachments by default notmuch-show can be slow displaying large attachments so hide them by default. The default maximum size is 10000 bytes/characters but it is customizable. Note that notmuch-show-insert-bodypart is also called from the reply code so we need to be a little careful.
2015-03-28 12:08:59 +01:00
(and long button))))
emacs: save image redisplay data during non-lazy display This data will eventually be used to redisplay hidden images. A certain amount of refactoring is done here to avoid code duplication.
2023-09-24 11:51:51 +02:00
(content-beg (point))
(part-data (list msg part mime-type nth depth button)))
emacs: bugfix attachment content-type as mime-type handling Notmuch puts attachments in as declared content-type except when the content-type is application/octet-stream it tries to guess the type from the filename/extension. This means that viewing a pdf (for example) which is sent as application/octet-strem invokes the pdf viewer rather than just offering to save the part. Recent changes to the attachment handling (commit 1546387d) changed (broke) this. This patch stores the calculated mime-type with the part and changes the attachment part handlers can use it instead.
2013-07-31 20:39:05 +02:00
;; Store the computed mime-type for later use (e.g. by attachment handlers).
(plist-put part :computed-type mime-type)
emacs: save image redisplay data during non-lazy display This data will eventually be used to redisplay hidden images. A certain amount of refactoring is done here to avoid code duplication.
2023-09-24 11:51:51 +02:00
(cond
(show-part
(apply #'notmuch-show-insert-bodypart-internal part-data)
(when (and button (string-match "^image/" mime-type))
(button-put button :notmuch-redisplay-data part-data)))
(t
emacs/show: Accommodate the lack of part header buttons Various pieces of code assumed (reasonably) that part header buttons are present. Modify them to avoid problems if no part headers were inserted.
2016-02-20 19:24:37 +01:00
(when button
emacs: save image redisplay data during non-lazy display This data will eventually be used to redisplay hidden images. A certain amount of refactoring is done here to avoid code duplication.
2023-09-24 11:51:51 +02:00
(button-put button :notmuch-lazy-part part-data))))
emacs: show: add overlays for each part This makes notmuch-show-insert-bodypart add an overlay for any non-trivial part with a button header (currently the first text/plain part does not have a button). At this point the overlay is available to the button but there is no action using it yet. In addition the argument HIDE is passed down to notmuch-show-insert-part-overlays to request that the part be hidden by default but this is not acted on yet.
2012-12-18 20:27:58 +01:00
;; Some of the body part handlers leave point somewhere up in the
;; part, so we make sure that we're down at the end.
(goto-char (point-max))
;; Ensure that the part ends with a carriage return.
(unless (bolp)
(insert "\n"))
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
;; We do not create the overlay for hidden (lazy) parts until
;; they are inserted.
emacs: insert quotable parts in reply as they are displayed in show view In reply, insert quotable parts using notmuch-show-insert-bodypart instead of calling notmuch-mm-display-part-inline directly to render the quoted parts as they are rendered in show view. We use a temp buffer to not leak text properties from the show renderer into the reply. This way we also don't need to worry about narrowing or point placement. Credits to Mark Walters <markwalters1009@gmail.com> and Austin Clements <amdragon@MIT.EDU> for getting this part straight. The notable change is that replies to text/calendar parts quote the pretty printed output of icalendar-import-buffer rather than the ugly raw vcalendar.
2013-09-01 19:59:53 +02:00
(if show-part
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
(notmuch-show-create-part-overlays button content-beg (point))
emacs: show: modify the way hidden state is recorded. Previously, whether a part was hidden or shown was recorded in the invisibility/visibility of the part overlay. Since we are going to have lazily rendered parts with no overlay store the hidden/shown state in the part button itself. Additionally, in preparation for the invisible part handling move the actual hiding of the hidden parts to insert-bodypart from create-part-overlays. Finally, we will need to know whether a part-insertion has done anything (it won't if the invisible part cannot be displayed by emacs) so we slightly rejig the code order in notmuch-show-toggle-part-invisibility to make it easier for the function to set an appropriate return value.
2013-06-10 06:57:11 +02:00
(save-excursion
(notmuch-show-toggle-part-invisibility button)))
emacs: show move addition of :notmuch-part to separate function This separates out the adding of the :notmuch-part text property to a separate function to simplify calling from the lazy part insertion code.
2013-06-10 06:57:12 +02:00
(notmuch-show-record-part-information part beg (point))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Display all body parts using `notmuch part --part=<n>' Use the `notmuch part' command to access body parts not currently included in the JSON output and display those body parts appropriately.
2010-04-01 19:33:46 +02:00
(defun notmuch-show-insert-body (msg body depth)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Insert the body BODY at depth DEPTH in the current thread."
emacs: Rewrite content ID handling Besides generally cleaning up the code and separating the general content ID handling from the w3m-specific code, this fixes several problems. Foremost is that, previously, the code roughly assumed that referenced parts would be in the same multipart/related as the reference. According to RFC 2392, nothing could be further from the truth: content IDs are supposed to be globally unique and globally addressable. This is nonsense, but this patch at least fixes things so content IDs can be anywhere in the same message. As a side-effect of the above, this handles multipart/alternate content-IDs more in line with RFC 2046 section 5.1.2 (not that I've ever seen this in the wild). This also properly URL-decodes cid: URLs, as per RFC 2392 (the previous code did not), and applies crypto settings from the show buffer (the previous code used the global crypto settings).
2015-01-24 22:17:02 +01:00
;; Register all content IDs for this message. According to RFC
;; 2392, content IDs are *global*, but it's okay if an MUA treats
;; them as only global within a message.
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(notmuch-show--register-cids msg (car body))
Don't quote lambda forms This generates byte-compiler warnings on (at least) current trunk versions of Emacs. The quote is not necessary; lambda forms are self-quoting.
2011-12-17 16:47:48 +01:00
(mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-make-symbol (type)
(make-symbol (concat "notmuch-show-" type)))
emacs: Elide the display of repeated subjects in thread display mode. Collapsed messages do not show a "Subject:" line if the subject is the same as that of the previous message.
2010-11-08 11:44:08 +01:00
(defun notmuch-show-strip-re (string)
emacs: only strip "re:" in the beginning of subject Fix notmuch-show-strip-re by matching "re:" only in the beginning of the input string.
2012-06-05 17:42:51 +02:00
(replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
emacs: Elide the display of repeated subjects in thread display mode. Collapsed messages do not show a "Subject:" line if the subject is the same as that of the previous message.
2010-11-08 11:44:08 +01:00
(defvar notmuch-show-previous-subject "")
(make-variable-buffer-local 'notmuch-show-previous-subject)
emacs/show: provide notmuch-show-choose-duplicate This new command allows the user to interactively choose a different duplicate (file) to display for a given message in notmuch-show-mode. Since both tree and unthreaded view use notmuch-show-mode, this provides the same facility there.
2022-07-01 23:45:45 +02:00
(defun notmuch-show-choose-duplicate (duplicate)
emacs: add docstring for notmuch-show-choose-duplicate It should have one in any case, but in particular it is needed for the manual.
2022-07-31 14:46:51 +02:00
"Display message file with index DUPLICATE in place of the current one.
Message file indices are based on the order the files are
discovered by `notmuch new' (and hence are somewhat arbitrary),
and correspond to those passed to the \"\\-\\-duplicate\" arguments
to the CLI.
When called interactively, the function will prompt for the index
of the file to display. An error will be signaled if the index
is out of range."
emacs/show: provide notmuch-show-choose-duplicate This new command allows the user to interactively choose a different duplicate (file) to display for a given message in notmuch-show-mode. Since both tree and unthreaded view use notmuch-show-mode, this provides the same facility there.
2022-07-01 23:45:45 +02:00
(interactive "Nduplicate: ")
(let ((count (length (notmuch-show-get-prop :filename))))
(when (or (> duplicate count)
(< duplicate 1))
(error "Duplicate %d out of range [1,%d]" duplicate count)))
(notmuch-show-move-to-message-top)
(save-excursion
(let* ((extent (notmuch-show-message-extent))
(id (notmuch-show-get-message-id))
(depth (notmuch-show-get-depth))
(inhibit-read-only t)
(new-msg (notmuch--run-show (list id) duplicate)))
;; clean up existing overlays to avoid extending them.
(dolist (o (overlays-in (car extent) (cdr extent)))
(delete-overlay o))
;; pretend insertion is happening at end of buffer
(narrow-to-region (point-min) (car extent))
;; Insert first, then delete, to avoid marker for start of next
;; message being in same place as the start of this one.
(notmuch-show-insert-msg new-msg depth)
(widen)
(delete-region (point) (cdr extent)))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-insert-msg (msg depth)
"Insert the message MSG at depth DEPTH in the current thread."
emacs: Elide the display of repeated subjects in thread display mode. Collapsed messages do not show a "Subject:" line if the subject is the same as that of the previous message.
2010-11-08 11:44:08 +01:00
(let* ((headers (plist-get msg :headers))
;; Indentation causes the buffer offset of the start/end
;; points to move, so we must use markers.
message-start message-end
content-start content-end
headers-start headers-end
(bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(setq message-start (point-marker))
emacs/show: use plist to pass message info to n-s-insert-headerline This should allow calling notmuch-show-insert-headerline from other places without duplicating the set of plist accesses.
2022-11-11 22:48:29 +01:00
(notmuch-show-insert-headerline msg depth (plist-get msg :tags))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(setq content-start (point-marker))
;; Set `headers-start' to point after the 'Subject:' header to be
;; compatible with the existing implementation. This just sets it
;; to after the first header.
(notmuch-show-insert-headers headers)
(save-excursion
(goto-char content-start)
emacs: Elide the display of repeated subjects in thread display mode. Collapsed messages do not show a "Subject:" line if the subject is the same as that of the previous message.
2010-11-08 11:44:08 +01:00
;; If the subject of this message is the same as that of the
;; previous message, don't display it when this message is
;; collapsed.
emacs: Use 'unless' instead of 'when' and 'not' Also use 'unless' in a few cases where previously 'if' was used with 'not' but without an ELSE part.
2020-08-08 13:49:42 +02:00
(unless (string= notmuch-show-previous-subject bare-subject)
emacs: Elide the display of repeated subjects in thread display mode. Collapsed messages do not show a "Subject:" line if the subject is the same as that of the previous message.
2010-11-08 11:44:08 +01:00
(forward-line 1))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(setq headers-start (point-marker)))
(setq headers-end (point-marker))
emacs: Elide the display of repeated subjects in thread display mode. Collapsed messages do not show a "Subject:" line if the subject is the same as that of the previous message.
2010-11-08 11:44:08 +01:00
(setq notmuch-show-previous-subject bare-subject)
emacs: Move the blank line from the bottom of the headers to the top of the body. The blank line doesn't really change position, but is now considered to be part of the body rather than part of the headers. This means that it is visible when the body is visible rather than when the headers are visible.
2012-01-30 17:52:20 +01:00
;; A blank line between the headers and the body.
(insert "\n")
emacs: Allow the indentation of content to be toggled. Very deeply indented content is sometimes difficult to read (particular for something like patches). Allow the indentation of the content to be toggled with '<'. Indentation of the header lines is not affected, so it remains possible to see the structure of the thread.
2012-02-08 09:02:14 +01:00
(notmuch-show-insert-body msg (plist-get msg :body)
(if notmuch-show-indent-content depth 0))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; Ensure that the body ends with a newline.
emacs: globally replace non-branching "(if (not ..." with "(unless ..." Less code, same results, without sacrificing readability.
2012-01-16 11:56:40 +01:00
(unless (bolp)
(insert "\n"))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(setq content-end (point-marker))
;; Indent according to the depth in the thread.
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when notmuch-show-indent-content
(indent-rigidly content-start
content-end
(* notmuch-show-indent-messages-width depth)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(setq message-end (point-max-marker))
;; Save the extents of this message over the whole text of the
;; message.
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(put-text-property message-start message-end
:notmuch-message-extent
(cons message-start message-end))
emacs: Eliminate buffer invisibility specs from show and wash Previously, all visibility in show buffers for headers, message bodies, and washed text was specified by generating one or more symbols for each region and creating overlays with their 'invisible property set to carefully crafted combinations of these symbols. Visibility was controlled not by modifying the overlays directly, but by adding and removing the generated symbols from a gigantic buffer invisibilty spec. This has myriad negative consequences. It's slow because Emacs' display engine has to traverse the buffer invisibility list for every overlay and, since every overlay has its own symbol, this makes rendering O(N^2) in the number of overlays. It composes poorly because symbol-type 'invisible properties are taken from the highest priority overlay over a given character (which is often ambiguous!), rather than being gathered from all overlays over a character. As a result, we have to include symbols related to message hiding in the wash code lest the wash overlays un-hide parts of hidden messages. It also requires various workarounds for isearch to properly open overlays, to set up buffer-invisibility-spec for remove-from-invisibility-spec to work right, and to explicitly refresh the display after updating the buffer invisibility spec. None of this is necessary. This patch converts show and wash to use simple boolean 'invisible properties and to not use the buffer invisibility spec. Rather than adding and removing generated symbols from the invisibility spec, the code now directly toggles the 'invisible property of the appropriate overlay. This speeds up rendering because the display engine only has to check the boolean values of the overlays over a character. It composes nicely because text will be invisible if *any* overlay over it has 'invisible t, which means we can overlap invisibility overlays with abandon. We no longer need any of the workarounds mentioned above. And it fixes a minor bug for free: now, when isearch opens a washed region, the button text will update to say "Click/Enter to hide" rather than remaining unchanged.
2012-12-18 07:40:10 +01:00
;; Create overlays used to control visibility
(plist-put msg :headers-overlay (make-overlay headers-start headers-end))
(plist-put msg :message-overlay (make-overlay headers-start content-end))
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
(plist-put msg :depth depth)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; Save the properties for this message. Currently this saves the
;; entire message (augmented it with other stuff), which seems
;; like overkill. We might save a reduced subset (for example, not
;; the content).
(notmuch-show-set-message-properties msg)
emacs: Allow headers to be shown by default in show mode Add `notmuch-show-headers-visible' which, when set `t', causes headers to be shown by default.
2010-04-23 13:54:21 +02:00
;; Set header visibility.
emacs: Rename notmuch-show-headers to notmuch-message-headers And similarly for notmuch-show-headers-visible to notmuch-message-headers-visible. I've never liked notmuch-show as a namespace prefix, but it looks especially bad when it appears as "Notmuch Show Headers Visible" in the customize buffer. Give nicer names to these variables which are exported for user manipulation.
2010-04-24 15:11:57 +02:00
(notmuch-show-headers-visible msg notmuch-message-headers-visible)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; Message visibility depends on whether it matched the search
;; criteria.
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(notmuch-show-message-visible msg (and (plist-get msg :match)
(not (plist-get msg :excluded))))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Toggle commands
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
(defun notmuch-show-toggle-process-crypto ()
"Toggle the processing of cryptographic MIME parts."
(interactive)
(setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
(message (if notmuch-show-process-crypto
"Processing cryptographic MIME parts."
"Not processing cryptographic MIME parts."))
emacs: Reverse the meaning of notmuch-show-refresh-view's argument Consensus seems to be that people prefer that refreshing show buffers retains state by default, rather than resetting it by default. This turns out to be the case in the code, as well. In fact, there's even a test for this that's been marked broken for several months, which this patch finally gets to mark as fixed.
2012-02-21 16:42:32 +01:00
(notmuch-show-refresh-view))
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
emacs: Allow `notmuch-show-mode' to display only matching messages. The current behaviour (all messages shown, non-matching collapsed) is retained as the default. Type '!' to switch to showing only the matching messages - non-matching messages are not available. '!' will switch back to showing everything.
2012-02-08 09:02:12 +01:00
(defun notmuch-show-toggle-elide-non-matching ()
"Toggle the display of non-matching messages."
(interactive)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(setq notmuch-show-elide-non-matching-messages
(not notmuch-show-elide-non-matching-messages))
emacs: Allow `notmuch-show-mode' to display only matching messages. The current behaviour (all messages shown, non-matching collapsed) is retained as the default. Type '!' to switch to showing only the matching messages - non-matching messages are not available. '!' will switch back to showing everything.
2012-02-08 09:02:12 +01:00
(message (if notmuch-show-elide-non-matching-messages
"Showing matching messages only."
"Showing all messages."))
emacs: Reverse the meaning of notmuch-show-refresh-view's argument Consensus seems to be that people prefer that refreshing show buffers retains state by default, rather than resetting it by default. This turns out to be the case in the code, as well. In fact, there's even a test for this that's been marked broken for several months, which this patch finally gets to mark as fixed.
2012-02-21 16:42:32 +01:00
(notmuch-show-refresh-view))
emacs: Allow `notmuch-show-mode' to display only matching messages. The current behaviour (all messages shown, non-matching collapsed) is retained as the default. Type '!' to switch to showing only the matching messages - non-matching messages are not available. '!' will switch back to showing everything.
2012-02-08 09:02:12 +01:00
emacs: Allow the indentation of content to be toggled. Very deeply indented content is sometimes difficult to read (particular for something like patches). Allow the indentation of the content to be toggled with '<'. Indentation of the header lines is not affected, so it remains possible to see the structure of the thread.
2012-02-08 09:02:14 +01:00
(defun notmuch-show-toggle-thread-indentation ()
"Toggle the indentation of threads."
(interactive)
(setq notmuch-show-indent-content (not notmuch-show-indent-content))
(message (if notmuch-show-indent-content
"Content is indented."
"Content is not indented."))
emacs: Reverse the meaning of notmuch-show-refresh-view's argument Consensus seems to be that people prefer that refreshing show buffers retains state by default, rather than resetting it by default. This turns out to be the case in the code, as well. In fact, there's even a test for this that's been marked broken for several months, which this patch finally gets to mark as fixed.
2012-02-21 16:42:32 +01:00
(notmuch-show-refresh-view))
emacs: Allow the indentation of content to be toggled. Very deeply indented content is sometimes difficult to read (particular for something like patches). Allow the indentation of the content to be toggled with '<'. Indentation of the header lines is not affected, so it remains possible to see the structure of the thread.
2012-02-08 09:02:14 +01:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Main insert functions
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-insert-tree (tree depth)
"Insert the message tree TREE at depth DEPTH in the current thread."
(let ((msg (car tree))
(replies (cadr tree)))
emacs: make elide messages use notmuch-show for omitting messages. Previously the elide messages code got the entire-thread from notmuch-show.c and then threw away all non-matching messages. This version calls notmuch-show.c without the --entire-thread flag so it never receives the non-matching messages in the first place. This makes it substantially faster.
2012-06-16 12:21:46 +02:00
;; We test whether there is a message or just some replies.
(when msg
emacs/show: introduce notmuch-show-height-limit Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-06-28 03:02:04 +02:00
(notmuch-show--mark-height tree)
emacs: make elide messages use notmuch-show for omitting messages. Previously the elide messages code got the entire-thread from notmuch-show.c and then threw away all non-matching messages. This version calls notmuch-show.c without the --entire-thread flag so it never receives the non-matching messages in the first place. This makes it substantially faster.
2012-06-16 12:21:46 +02:00
(notmuch-show-insert-msg msg depth))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(notmuch-show-insert-thread replies (1+ depth))))
(defun notmuch-show-insert-thread (thread depth)
"Insert the thread THREAD at depth DEPTH in the current forest."
Don't quote lambda forms This generates byte-compiler warnings on (at least) current trunk versions of Emacs. The quote is not necessary; lambda forms are self-quoting.
2011-12-17 16:47:48 +01:00
(mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-insert-forest (forest)
"Insert the forest of threads FOREST."
Don't quote lambda forms This generates byte-compiler warnings on (at least) current trunk versions of Emacs. The quote is not necessary; lambda forms are self-quoting.
2011-12-17 16:47:48 +01:00
(mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Link buttons
emacs: Improve the regexp used to match id:'s in messages This regexp agrees with Xapian query syntax much more closely, though we specifically disallow various cases that would be confusing in the context of an email body (e.g., punctuation at the end of an id: link is not considered part of the id: link because it's probably part of the surrounding text). In particular, this handles id: links that are not surrounded by quotes much better, which stash is much more likely to generate now that we don't quote id's that don't need to be quoted. It also handles quoted id: links better. We update the buttonization test to reflect the new pattern.
2012-11-15 20:49:53 +01:00
(defvar notmuch-id-regexp
(concat
;; Match the id: prefix only if it begins a word (to disallow, for
;; example, matching cid:).
"\\<id:\\("
;; If the term starts with a ", then parse Xapian's quoted boolean
;; term syntax, which allows for anything as long as embedded
;; double quotes escaped by doubling them. We also disallow
;; newlines (which Xapian allows) to prevent runaway terms.
"\"\\([^\"\n]\\|\"\"\\)*\""
;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
;; next space or ). We disallow [.,;] as the last character
;; because these are probably part of the surrounding text, and not
;; part of the id. This doesn't match single character ids; meh.
"\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
"\\)")
"The regexp used to match id: links in messages.")
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
(defvar notmuch-mid-regexp
;; goto-address-url-regexp matched cid: links, which have the same
;; grammar as the message ID part of a mid: link. Construct the
;; regexp using the same technique as goto-address-url-regexp.
(concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
"The regexp used to match mid: links in messages.
See RFC 2392.")
emacs: Turn id:"<message-id>" elements into buttons for notmuch searches This fixes the minor annoyance that message ids were parsed as mail addresses by goto-address-mode in notmuch-show buffers.
2011-10-28 16:48:58 +02:00
(defun notmuch-show-buttonise-links (start end)
"Buttonise URLs and mail addresses between START and END.
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
This also turns id:\"<message id>\"-parts and mid: links into
buttons for a corresponding notmuch search."
emacs: Turn id:"<message-id>" elements into buttons for notmuch searches This fixes the minor annoyance that message ids were parsed as mail addresses by goto-address-mode in notmuch-show buffers.
2011-10-28 16:48:58 +02:00
(goto-address-fontify-region start end)
(save-excursion
emacs/show: force notmuch-show-buttonise-links to act on lines This seems to fix a problem with emacs 25 creating partial buttons by calling n-s-b-l with a region that does not include the whole button. I'm not 100% sure it's legit to act outside the region passed by jit-lock, but goto-address-fontify-region (where I borrowed the code from) already does this, so this patch to not make things worse.
2016-10-10 00:30:44 +02:00
(let (links
(beg-line (progn (goto-char start) (line-beginning-position)))
(end-line (progn (goto-char end) (line-end-position))))
(goto-char beg-line)
(while (re-search-forward notmuch-id-regexp end-line t)
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
(push (list (match-beginning 0) (match-end 0)
(match-string-no-properties 0)) links))
emacs/show: force notmuch-show-buttonise-links to act on lines This seems to fix a problem with emacs 25 creating partial buttons by calling n-s-b-l with a region that does not include the whole button. I'm not 100% sure it's legit to act outside the region passed by jit-lock, but goto-address-fontify-region (where I borrowed the code from) already does this, so this patch to not make things worse.
2016-10-10 00:30:44 +02:00
(goto-char beg-line)
(while (re-search-forward notmuch-mid-regexp end-line t)
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
(let* ((mid-cid (match-string-no-properties 1))
(mid (save-match-data
(string-match "^[^/]*" mid-cid)
(url-unhex-string (match-string 0 mid-cid)))))
(push (list (match-beginning 0) (match-end 0)
(notmuch-id-to-query mid)) links)))
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(pcase-dolist (`(,beg ,end ,link) links)
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
;; Remove the overlay created by goto-address-mode
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(remove-overlays beg end 'goto-address t)
(make-text-button beg end
emacs: show: make buttons select window Emacs has two button type objects: widgets (as used for saved searches in notmuch-hello) and buttons as used by parts/citations and id links in notmuch-show. These two behave subtly differently when clicked with the mouse: widgets select the window clicked before running the action, buttons do not. This patch makes all of these behave the same: clicking always selects the clicked window. It does this by defining a notmuch-button-type supertype that the other notmuch buttons can inherit from. This supertype binds the mouse-action to select the window and then activate the button.
2013-01-07 22:07:20 +01:00
:type 'notmuch-button-type
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
'action `(lambda (arg)
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(notmuch-show ,link current-prefix-arg))
emacs: Buttonize mid: links This adds support for RFC 2392 mid: message ID links.
2012-11-15 20:49:54 +01:00
'follow-link t
'help-echo "Mouse-1, RET: search for this message"
'face goto-address-mail-face)))))
emacs: Turn id:"<message-id>" elements into buttons for notmuch searches This fixes the minor annoyance that message ids were parsed as mail addresses by goto-address-mode in notmuch-show buffers.
2011-10-28 16:48:58 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Show command
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;;;###autoload
emacs: show: use interactive instead of current-prefix-arg Currently notmuch-show looks at the prefix-arg directly via current-prefix-arg. This changes it to use the interactive specification. One test (for elide-toggle functionality) set the prefix arg directly. Update this test to set the new argument directly.
2013-10-13 09:39:12 +02:00
(defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Run \"notmuch show\" with the given thread ID and display results.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: show: use interactive instead of current-prefix-arg Currently notmuch-show looks at the prefix-arg directly via current-prefix-arg. This changes it to use the interactive specification. One test (for elide-toggle functionality) set the prefix arg directly. Update this test to set the new argument directly.
2013-10-13 09:39:12 +02:00
ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
The optional PARENT-BUFFER is the notmuch-search buffer from
which this notmuch-show command was executed, (so that the
next thread from that buffer can be show when done with this
one).
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
The optional QUERY-CONTEXT is a notmuch search term. Only
messages from the thread matching this search term are shown if
non-nil.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
fix sum moar typos [user-visible documentation in code] Various typo fixes in documentation within the code that can be made available to the user, (emacs function help strings, "notmuch help" output, notmuch man page, etc.). Signed-off-by: Pieter Praet <pieter@praet.org> Edited-by: Carl Worth <cworth@cworth.org> Restricted to just documentation and fixed fix of "comman" to "common" rather than "command".
2011-06-20 22:14:21 +02:00
The optional BUFFER-NAME provides the name of the buffer in
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
which the message thread is shown. If it is nil (which occurs
when the command is called interactively) the argument to the
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
function is used.
Returns the buffer containing the messages, or NIL if no messages
matched."
emacs: show: use interactive instead of current-prefix-arg Currently notmuch-show looks at the prefix-arg directly via current-prefix-arg. This changes it to use the interactive specification. One test (for elide-toggle functionality) set the prefix arg directly. Update this test to set the new argument directly.
2013-10-13 09:39:12 +02:00
(interactive "sNotmuch show: \nP")
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
(let ((buffer-name (generate-new-buffer-name
(or buffer-name
emacs: show: stop display of application/* parts Gnus seems to display application/zip and application/tar by default. This doesn't seem desirable so we override it. We only override if the user has not customized mm-inline-override-types themselves.
2017-01-28 10:47:42 +01:00
(concat "*notmuch-" thread-id "*"))))
emacs: factor out calculation of mm-inline-override-types The intended use case of this new function is to make reply behaviour track that of show with respect to attachments. Also fix the glob (which worked by fluke) into the documented regexp.
2022-03-19 11:07:53 +01:00
(mm-inline-override-types (notmuch--inline-override-types)))
emacs: Use pop-to-buffer-same-window rather than switch-to-buffer This means that notmuch commands obey display-buffer-alist so the user can customize how buffers show up. It also permits the use of C-x 4 4, C-x 5 5 and C-x t t, available in Emacs 28. For example, one can use C-x 4 4 M-x notmuch-jump-search RET to open a saved search in another window rather than the current window. Or in notmuch-search mode, C-x 5 5 RET to view the message at point in a new frame. notmuch-tree has custom buffer display logic, so bind display-buffer-overriding-action to make pop-to-buffer-same-window behave exactly as switch-to-buffer while that function is running.
2020-08-11 18:59:13 +02:00
(pop-to-buffer-same-window (get-buffer-create buffer-name))
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
;; No need to track undo information for this buffer.
(setq buffer-undo-list t)
(notmuch-show-mode)
;; Set various buffer local variables to their appropriate initial
;; state. Do this after enabling `notmuch-show-mode' so that they
;; aren't wiped out.
emacs: Only set one variable per setq form It's a bit weird to avoid having to write the "(setq ... )" more than once, just because we can. In a language that uses '=' for the same purpose we also happily use that once per assignment. While there are no benefit to using just one 'setq' there are some drawbacks. It is not always clear on first what is a key and what a value and as a result it is easy to make a mistake. Also it becomes harder to comment out just one assignment.
2020-08-08 13:49:40 +02:00
(setq notmuch-show-thread-id thread-id)
(setq notmuch-show-parent-buffer parent-buffer)
(setq notmuch-show-query-context
(if (or (string= query-context "")
(string= query-context "*"))
nil
query-context))
(setq notmuch-show-process-crypto notmuch-crypto-process-mime)
;; If `elide-toggle', invert the default value.
(setq notmuch-show-elide-non-matching-messages
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(if elide-toggle
(not notmuch-show-only-matching-messages)
notmuch-show-only-matching-messages))
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(jit-lock-register #'notmuch-show-buttonise-links)
Make keys of notmuch-tag-formats regexps and use caching This modifies `notmuch-tag-format-tag' to treat the keys of `notmuch-tag-formats' as (anchored) regexps, rather than literal strings. This is clearly more flexible, as it allows for prefix matching, defining a fallback format, etc. This may cause compatibility problems if people have customized `notmuch-tag-formats' to match tags that contain regexp specials, but this seems unlikely. Regular expression matching has quite a performance hit over string lookup, so this also introduces a simple cache from exact tags to formatted strings. The number of unique tags is likely to be quite small, so this cache should have a high hit rate. In addition to eliminating the regexp lookup in the common case, this cache stores fully formatted tags, eliminating the repeated evaluation of potentially expensive, user-specified formatting code. This makes regexp lookup at least as fast as assoc for unformatted tags (e.g., inbox) and *faster* than the current code for formatted tags (e.g., unread): inbox (usec) unread (usec) assoc: 0.4 2.8 regexp: 3.2 7.2 regexp+caching: 0.4 0.4 (Though even at 7.2 usec, tag formatting is not our top bottleneck.) This cache must be explicitly cleared to keep it coherent, so this adds the appropriate clearing calls.
2014-03-22 12:51:06 +01:00
(notmuch-tag-clear-cache)
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(let ((inhibit-read-only t))
(if (notmuch-show--build-buffer)
;; Messages were inserted into the buffer.
(current-buffer)
;; No messages were inserted - presumably none matched the
;; query.
(kill-buffer (current-buffer))
(ding)
(message "No messages matched the query!")
nil))))
Add notmuch-show--build-queries. notmuch-show--build-buffer now queries a list of queries built by the former. This simplifies the logic. It also provides an easy place to experiment with alternate sets of queries for given notmuch-show-* variables (e.g. users can use advice-add to do so in a surgical way).
2016-10-20 00:08:15 +02:00
(defun notmuch-show--build-queries (thread context)
"Return a list of queries to try for this search.
THREAD and CONTEXT are both strings, though CONTEXT may be nil.
When CONTEXT is not nil, the first query is the conjunction of it
and THREAD. The next query is THREAD alone, and serves as a
fallback if the prior matches no messages."
(let (queries)
(push (list thread) queries)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when context
(push (list thread "and (" context ")") queries))
Add notmuch-show--build-queries. notmuch-show--build-buffer now queries a list of queries built by the former. This simplifies the logic. It also provides an easy place to experiment with alternate sets of queries for given notmuch-show-* variables (e.g. users can use advice-add to do so in a surgical way).
2016-10-20 00:08:15 +02:00
queries))
emacs: notmuch-show-header-line: allow format strings and functions If a string value is assigned to notmuch-show-header-line, it's used as a format string to be passed passed to format-spec with `%s` substituted by the message's subject. If a function is given, it's called with the subject as argument, and its return value used as header line. As before, t means displaying the subject and nil not using any header line. Signed-off-by: jao <jao@gnu.org> Amended-by: db, docstring spelling fix
2022-06-01 11:53:36 +02:00
(defun notmuch-show--header-line-format ()
"Compute the header line format of a notmuch-show buffer."
(when notmuch-show-header-line
(let* ((s (notmuch-sanitize
(notmuch-show-strip-re (notmuch-show-get-subject))))
(subject (replace-regexp-in-string "%" "%%" s)))
(cond ((stringp notmuch-show-header-line)
(format-spec notmuch-show-header-line `((?s . ,subject))))
((functionp notmuch-show-header-line)
(funcall notmuch-show-header-line subject))
(notmuch-show-header-line subject)))))
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(defun notmuch-show--build-buffer (&optional state)
"Display messages matching the current buffer context.
Apply the previously saved STATE if supplied, otherwise show the
first relevant message.
If no messages match the query return NIL."
emacs/show: add parameter notmuch-show-single-message This dynamically bound variable can be set when the caller of notmuch-show guarantees that exactly one message will match the query. It avoids transporting and parsing the complete thread structure.
2021-06-26 14:04:27 +02:00
(let* ((cli-args (list "--exclude=false"))
(cli-args (if notmuch-show-elide-non-matching-messages (cons "--entire-thread=false" cli-args) cli-args))
;; "part 0 is the whole message (headers and body)" notmuch-show(1)
(cli-args (if notmuch-show-single-message (cons "--part=0" cli-args) cli-args))
Add notmuch-show--build-queries. notmuch-show--build-buffer now queries a list of queries built by the former. This simplifies the logic. It also provides an easy place to experiment with alternate sets of queries for given notmuch-show-* variables (e.g. users can use advice-add to do so in a surgical way).
2016-10-20 00:08:15 +02:00
(queries (notmuch-show--build-queries
notmuch-show-thread-id notmuch-show-query-context))
(forest nil)
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
;; Must be reset every time we are going to start inserting
;; messages into the buffer.
(notmuch-show-previous-subject ""))
Add notmuch-show--build-queries. notmuch-show--build-buffer now queries a list of queries built by the former. This simplifies the logic. It also provides an easy place to experiment with alternate sets of queries for given notmuch-show-* variables (e.g. users can use advice-add to do so in a surgical way).
2016-10-20 00:08:15 +02:00
;; Use results from the first query that returns some.
(while (and (not forest) queries)
emacs: mark notmuch-query.el as obsolete The only functionality actually used by notmuch is the base function notmuch-query-get-threads; the other functions in this file have nothing to do with that (single) use. Move that function into notmuch-lib.el and rename to reflect use. Deprecate the other functions in notmuch-query.el.
2022-06-28 13:50:55 +02:00
(setq forest (notmuch--run-show
Add notmuch-show--build-queries. notmuch-show--build-buffer now queries a list of queries built by the former. This simplifies the logic. It also provides an easy place to experiment with alternate sets of queries for given notmuch-show-* variables (e.g. users can use advice-add to do so in a surgical way).
2016-10-20 00:08:15 +02:00
(append cli-args (list "'") (car queries) (list "'"))))
emacs/show: add parameter notmuch-show-single-message This dynamically bound variable can be set when the caller of notmuch-show guarantees that exactly one message will match the query. It avoids transporting and parsing the complete thread structure.
2021-06-26 14:04:27 +02:00
(when (and forest notmuch-show-single-message)
(setq forest (list (list (list forest)))))
Add notmuch-show--build-queries. notmuch-show--build-buffer now queries a list of queries built by the former. This simplifies the logic. It also provides an easy place to experiment with alternate sets of queries for given notmuch-show-* variables (e.g. users can use advice-add to do so in a surgical way).
2016-10-20 00:08:15 +02:00
(setq queries (cdr queries)))
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(when forest
(notmuch-show-insert-forest forest)
;; Store the original tags for each message so that we can
;; display changes.
(notmuch-show-mapc
(lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
emacs: notmuch-show-header-line: allow format strings and functions If a string value is assigned to notmuch-show-header-line, it's used as a format string to be passed passed to format-spec with `%s` substituted by the message's subject. If a function is given, it's called with the subject as argument, and its return value used as header line. As before, t means displaying the subject and nil not using any header line. Signed-off-by: jao <jao@gnu.org> Amended-by: db, docstring spelling fix
2022-06-01 11:53:36 +02:00
(setq header-line-format (notmuch-show--header-line-format))
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(run-hooks 'notmuch-show-hook)
(if state
(notmuch-show-apply-state state)
;; With no state to apply, just go to the first message.
(notmuch-show-goto-first-wanted-message)))
;; Report back to the caller whether any messages matched.
forest))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Refresh command
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
(defun notmuch-show-capture-state ()
"Capture the state of the current buffer.
This includes:
- the list of open messages,
emacs: notmuch-show: refresh all windows displaying buffer This updates all windows displaying a notmuch-show buffer when the buffer refresh function is called. Each window displaying a notmuch-show buffer has its own currently displayed message based on the (point) location. We store the state of all displayed windows when refreshing a notmuch-show buffer and re-apply the current shown message (point) for all windows. Implementation note: Each window has it's own (point) value, besides the buffer's (point) value. Sometimes these values are identical like in the case where a single window displays a buffer. When multiple windows display a buffer, (point) returns each window's specific value. What we are storing in this changeset is the window values not the buffer point values. The buffer's point is returned only if no window is displaying the buffer, a case we do not care about here. Signed-off-by: Ioan-Adrian Ratiu <adi@adirat.com>
2016-10-15 09:32:44 +02:00
- the combination of current message id with/for each visible window."
(let* ((win-list (get-buffer-window-list (current-buffer) nil t))
(win-id-combo (mapcar (lambda (win)
(with-selected-window win
(list win (notmuch-show-get-message-id))))
win-list)))
(list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
emacs: set default in notmuch-read-query This adds the current query as a "default value" to notmuch-read-qeury. The default value is available via a down-arrow as opposed to history which is available from the up arrow. Note if a user presses return in the minibuffer this value is not returned. The implementation is simple but notmuch-read-query could be called via notmuch-search/notmuch-tree etc from any buffer so it makes sense to put the decision of how to extract the current query in notmuch-read-query rather than in each of the callers.
2014-06-23 23:06:46 +02:00
(defun notmuch-show-get-query ()
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Return the current query in this show buffer."
emacs: set default in notmuch-read-query This adds the current query as a "default value" to notmuch-read-qeury. The default value is available via a down-arrow as opposed to history which is available from the up arrow. Note if a user presses return in the minibuffer this value is not returned. The implementation is simple but notmuch-read-query could be called via notmuch-search/notmuch-tree etc from any buffer so it makes sense to put the decision of how to extract the current query in notmuch-read-query rather than in each of the callers.
2014-06-23 23:06:46 +02:00
(if notmuch-show-query-context
(concat notmuch-show-thread-id
" and ("
notmuch-show-query-context
")")
notmuch-show-thread-id))
emacs: split notmuch-show-apply-state Separate out a notmuch-show-goto-msg-id sub-function from notmuch-show-apply-state. There should be no functional change but the next patch will call the new function.
2015-06-13 10:08:08 +02:00
(defun notmuch-show-goto-message (msg-id)
"Go to message with msg-id."
(goto-char (point-min))
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
return t
until (not (notmuch-show-goto-message-next)))
emacs: split notmuch-show-apply-state Separate out a notmuch-show-goto-msg-id sub-function from notmuch-show-apply-state. There should be no functional change but the next patch will call the new function.
2015-06-13 10:08:08 +02:00
(goto-char (point-min))
(message "Message-id not found."))
(notmuch-show-message-adjust))
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
(defun notmuch-show-apply-state (state)
"Apply STATE to the current buffer.
This includes:
- opening the messages previously opened,
- closing all other messages,
emacs: notmuch-show: refresh all windows displaying buffer This updates all windows displaying a notmuch-show buffer when the buffer refresh function is called. Each window displaying a notmuch-show buffer has its own currently displayed message based on the (point) location. We store the state of all displayed windows when refreshing a notmuch-show buffer and re-apply the current shown message (point) for all windows. Implementation note: Each window has it's own (point) value, besides the buffer's (point) value. Sometimes these values are identical like in the case where a single window displays a buffer. When multiple windows display a buffer, (point) returns each window's specific value. What we are storing in this changeset is the window values not the buffer point values. The buffer's point is returned only if no window is displaying the buffer, a case we do not care about here. Signed-off-by: Ioan-Adrian Ratiu <adi@adirat.com>
2016-10-15 09:32:44 +02:00
- moving to the correct current message in every displayed window."
(let ((win-msg-alist (car state))
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
(open (cadr state)))
;; Open those that were open.
(goto-char (point-min))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(cl-loop do (notmuch-show-message-visible
(notmuch-show-get-message-properties)
(member (notmuch-show-get-message-id) open))
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
until (not (notmuch-show-goto-message-next)))
emacs: notmuch-show: refresh all windows displaying buffer This updates all windows displaying a notmuch-show buffer when the buffer refresh function is called. Each window displaying a notmuch-show buffer has its own currently displayed message based on the (point) location. We store the state of all displayed windows when refreshing a notmuch-show buffer and re-apply the current shown message (point) for all windows. Implementation note: Each window has it's own (point) value, besides the buffer's (point) value. Sometimes these values are identical like in the case where a single window displays a buffer. When multiple windows display a buffer, (point) returns each window's specific value. What we are storing in this changeset is the window values not the buffer point values. The buffer's point is returned only if no window is displaying the buffer, a case we do not care about here. Signed-off-by: Ioan-Adrian Ratiu <adi@adirat.com>
2016-10-15 09:32:44 +02:00
(dolist (win-msg-pair win-msg-alist)
(with-selected-window (car win-msg-pair)
;; Go to the previously open message in this window
(notmuch-show-goto-message (cadr win-msg-pair))))))
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
emacs: Reverse the meaning of notmuch-show-refresh-view's argument Consensus seems to be that people prefer that refreshing show buffers retains state by default, rather than resetting it by default. This turns out to be the case in the code, as well. In fact, there's even a test for this that's been marked broken for several months, which this patch finally gets to mark as fixed.
2012-02-21 16:42:32 +01:00
(defun notmuch-show-refresh-view (&optional reset-state)
emacs: Rework crypto switch toggle. Re-work the existing crypto switch toggle to be based on a persistant buffer-local variable. To allow this, modify `notmuch-show-refresh-view' to erase and re-draw in the current buffer rather than killing the current buffer and creating a new one. (This will also allow more per-buffer behaviour in future patches.) Add a binding ('$') to toggle crypto processing of the current buffer and remove the prefix argument approach that achieves a similar result.
2012-02-08 09:02:10 +01:00
"Refresh the current view.
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
Refreshes the current view, observing changes in display
emacs: Reverse the meaning of notmuch-show-refresh-view's argument Consensus seems to be that people prefer that refreshing show buffers retains state by default, rather than resetting it by default. This turns out to be the case in the code, as well. In fact, there's even a test for this that's been marked broken for several months, which this patch finally gets to mark as fixed.
2012-02-21 16:42:32 +01:00
preferences. If invoked with a prefix argument (or RESET-STATE is
non-nil) then the state of the buffer (open/closed messages) is
reset based on the original query."
emacs: allow to set RETAIN-STATE for `notmuch-show-refresh-view' interactively The notmuch-show view refresh function (`notmuch-show-refresh-view', bound to "=") accepts an optional RETAIN-STATE argument. The patch allows to set this argument interactively by using "C-u =".
2012-02-13 12:09:07 +01:00
(interactive "P")
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
(let ((inhibit-read-only t)
emacs/show: restrict inlined mimetypes on refresh. This fixes the bug reported by Al [1]. Essentially apply the same fix as [2] in a different place. [1]: id:877d41nmr1.fsf@gmail.com [2]: 90a7c1af368a527700dcde9b0dcbd760afc7bd92
2022-08-01 13:39:18 +02:00
(mm-inline-override-types (notmuch--inline-override-types))
emacs: Reverse the meaning of notmuch-show-refresh-view's argument Consensus seems to be that people prefer that refreshing show buffers retains state by default, rather than resetting it by default. This turns out to be the case in the code, as well. In fact, there's even a test for this that's been marked broken for several months, which this patch finally gets to mark as fixed.
2012-02-21 16:42:32 +01:00
(state (unless reset-state
(notmuch-show-capture-state))))
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
;; `erase-buffer' does not seem to remove overlays, which can lead
emacs: show: refresh buffer did not remove overlays Previously refreshing the notmuch show buffer did not remove overlays which meant that if the user refreshed a message with images the images would remain and then the new text was added after. One might have guessed that erase-buffer would have removed them but it seems not. Thus force the removal of overlays with remove-overlays.
2012-12-05 13:11:49 +01:00
;; to weird effects such as remaining images, so remove them
;; manually.
(remove-overlays)
emacs: Optionally retain the state of the buffer during `notmuch-show-refresh-view'. With an argument, record and reply the state of the buffer during `notmuch-show-refresh-view'. In this context, "state" is defined as: - the open/closed state of each message, - the current message. Traditional use of refresh with the = key does not retain the state. The recently introduced toggle commands ($, !, < and >) do retain the state.
2012-02-08 09:02:16 +01:00
(erase-buffer)
emacs: Report a lack of matches when calling `notmuch-show'. If the basic query passed to `notmuch-show' generates no results, ring the bell and inform the user that no messages matched the query rather than displaying an empty buffer and showing an obscure error. Similarly when refreshing a `notmuch-show' buffer and no messages match.
2016-02-11 09:33:27 +01:00
(unless (notmuch-show--build-buffer state)
;; No messages were inserted.
(kill-buffer (current-buffer))
(ding)
(message "Refreshing the buffer resulted in no messages!"))))
emacs: add notmuch-show-refresh-view function This function, like the equivalent for notmuch-search, just refreshes the current show view. Like in notmuch-search, this new function is bound to "=". If a prefix is given then the redisplay happens with the crypto-switch set, which displays the thread with the opposite logic of whatever is set in the notmuch-crypto-process-mime customization variable.
2011-05-29 02:09:43 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Keymaps
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defvar notmuch-show-stash-map
(let ((map (make-sparse-keymap)))
(define-key map "c" 'notmuch-show-stash-cc)
(define-key map "d" 'notmuch-show-stash-date)
(define-key map "F" 'notmuch-show-stash-filename)
(define-key map "f" 'notmuch-show-stash-from)
(define-key map "i" 'notmuch-show-stash-message-id)
emacs: add keybind and function to stash Message-ID without prefix Add function `notmuch-show-stash-message-id-stripped' which stashes a Message-ID after ripping off the prefix and quotes, add bind it to "I" key in `notmuch-show-stash-map'. Simplifying `notmuch-show-get-message-id' instead might seem better, but that would require concat'ing in 9 places instead of 1. Signed-off-by: Pieter Praet <pieter@praet.org>
2011-06-30 10:20:50 +02:00
(define-key map "I" 'notmuch-show-stash-message-id-stripped)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(define-key map "s" 'notmuch-show-stash-subject)
(define-key map "T" 'notmuch-show-stash-tags)
(define-key map "t" 'notmuch-show-stash-to)
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
(define-key map "l" 'notmuch-show-stash-mlarchive-link)
(define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
emacs: add stash support for git send-email command line Stash From/To/Cc as --to/--to/--cc, respectively, and Message-Id as --in-reply-to, suitable for pasting to git send-email command line.
2015-01-02 18:48:17 +01:00
(define-key map "G" 'notmuch-show-stash-git-send-email)
emacs: add '?' to some prefix keymaps to describe its bindings Added function notmuch-subkeymap-help to describe keybindings of a subkeymap (eg after . or c in notmuch-search and notmuch-show).
2013-11-14 10:49:46 +01:00
(define-key map "?" 'notmuch-subkeymap-help)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
map)
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Submap for stash commands.")
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(fset 'notmuch-show-stash-map notmuch-show-stash-map)
emacs: Bind MIME part commands to "." submap Since the part commands are no longer tied to a button, but can be applied with point anywhere within a part, bind the part commands keymap to "." everywhere in the show buffer. This lets you save or view parts without having to navigate to the part button, and is particularly useful for parts that have no button. This removes the un-prefixed MIME part commands from the part button keymap, but that's okay because those clashed in annoying ways with show buffer bindings like "s" for search. RET on part buttons is unaffected, which is the most important part button binding.
2013-05-30 03:13:47 +02:00
(defvar notmuch-show-part-map
(let ((map (make-sparse-keymap)))
(define-key map "s" 'notmuch-show-save-part)
(define-key map "v" 'notmuch-show-view-part)
(define-key map "o" 'notmuch-show-interactively-view-part)
(define-key map "|" 'notmuch-show-pipe-part)
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(define-key map "m" 'notmuch-show-choose-mime-of-part)
emacs: add '?' to some prefix keymaps to describe its bindings Added function notmuch-subkeymap-help to describe keybindings of a subkeymap (eg after . or c in notmuch-search and notmuch-show).
2013-11-14 10:49:46 +01:00
(define-key map "?" 'notmuch-subkeymap-help)
emacs: Bind MIME part commands to "." submap Since the part commands are no longer tied to a button, but can be applied with point anywhere within a part, bind the part commands keymap to "." everywhere in the show buffer. This lets you save or view parts without having to navigate to the part button, and is particularly useful for parts that have no button. This removes the un-prefixed MIME part commands from the part button keymap, but that's okay because those clashed in annoying ways with show buffer bindings like "s" for search. RET on part buttons is unaffected, which is the most important part button binding.
2013-05-30 03:13:47 +02:00
map)
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Submap for part commands.")
emacs: Bind MIME part commands to "." submap Since the part commands are no longer tied to a button, but can be applied with point anywhere within a part, bind the part commands keymap to "." everywhere in the show buffer. This lets you save or view parts without having to navigate to the part button, and is particularly useful for parts that have no button. This removes the un-prefixed MIME part commands from the part button keymap, but that's okay because those clashed in annoying ways with show buffer bindings like "s" for search. RET on part buttons is unaffected, which is the most important part button binding.
2013-05-30 03:13:47 +02:00
(fset 'notmuch-show-part-map notmuch-show-part-map)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defvar notmuch-show-mode-map
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
(let ((map (make-sparse-keymap)))
(set-keymap-parent map notmuch-common-keymap)
(define-key map "Z" 'notmuch-tree-from-show-current-query)
Add a U binding to switch to unthreaded from other views We have shortcuts S and Z to let the user switch to Search view and Tree view with the current search. Add U to let the user switch to unthreaded view from the current search, and ensure that S and Z switch from unthreaded to search and tree veiew respectively.
2020-02-27 18:16:51 +01:00
(define-key map "U" 'notmuch-unthreaded-from-show-current-query)
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
(define-key map (kbd "<C-tab>") 'widget-backward)
(define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
(define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
(define-key map (kbd "TAB") 'notmuch-show-next-button)
(define-key map "f" 'notmuch-show-forward-message)
emacs: Add `notmuch-show-forward-open-messages'. Add a function to forward all open messages in the current view of a thread. Bind this to "F".
2016-02-08 12:34:21 +01:00
(define-key map "F" 'notmuch-show-forward-open-messages)
emacs: bind notmuch-show-resend-message to 'b' in notmuch-show mode This binding is similar to mutt's, which is bind {mode} b "bounce-message" # remail a message to another user where {mode} is 'index', 'pager' or 'attach'.
2016-05-07 21:03:12 +02:00
(define-key map "b" 'notmuch-show-resend-message)
emacs: add a filter option to show Show the current thread with a different filter (i.e., open messages in the thread matching the new query). Bound to 'l' for "limit". Note that it is not the same as filter in search mode as it replaces the existing query rather than ANDing with it (but it does keep the thread-id part of the query).
2015-06-13 10:08:09 +02:00
(define-key map "l" 'notmuch-show-filter-thread)
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
(define-key map "r" 'notmuch-show-reply-sender)
(define-key map "R" 'notmuch-show-reply)
(define-key map "|" 'notmuch-show-pipe-message)
(define-key map "w" 'notmuch-show-save-attachments)
(define-key map "V" 'notmuch-show-view-raw-message)
emacs: resume messages Provide functionality to resume editing a message previously saved with notmuch-draft-save, including decoding the X-Notmuch-Emacs-Secure header. Resume gets the raw file from notmuch and using the emacs function mime-to-mml reconstructs the message (including attachments). 'e' is bound to resume a draft from show or tree mode.
2016-11-13 15:08:50 +01:00
(define-key map "e" 'notmuch-show-resume-message)
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
(define-key map "c" 'notmuch-show-stash-map)
(define-key map "h" 'notmuch-show-toggle-visibility-headers)
emacs: add a tag jump menu Add a customisable "jump" style menu for doing tagging operations.
2016-09-20 21:57:16 +02:00
(define-key map "k" 'notmuch-tag-jump)
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
(define-key map "*" 'notmuch-show-tag-all)
(define-key map "-" 'notmuch-show-remove-tag)
(define-key map "+" 'notmuch-show-add-tag)
(define-key map "X" 'notmuch-show-archive-thread-then-exit)
(define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
(define-key map "A" 'notmuch-show-archive-thread-then-next)
(define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
(define-key map "N" 'notmuch-show-next-message)
(define-key map "P" 'notmuch-show-previous-message)
(define-key map "n" 'notmuch-show-next-open-message)
(define-key map "p" 'notmuch-show-previous-open-message)
(define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
(define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
(define-key map (kbd "DEL") 'notmuch-show-rewind)
(define-key map " " 'notmuch-show-advance-and-archive)
(define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
(define-key map (kbd "RET") 'notmuch-show-toggle-message)
(define-key map "#" 'notmuch-show-print-message)
(define-key map "!" 'notmuch-show-toggle-elide-non-matching)
(define-key map "$" 'notmuch-show-toggle-process-crypto)
emacs/show: provide notmuch-show-choose-duplicate This new command allows the user to interactively choose a different duplicate (file) to display for a given message in notmuch-show-mode. Since both tree and unthreaded view use notmuch-show-mode, this provides the same facility there.
2022-07-01 23:45:45 +02:00
(define-key map "%" 'notmuch-show-choose-duplicate)
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
(define-key map "<" 'notmuch-show-toggle-thread-indentation)
(define-key map "t" 'toggle-truncate-lines)
(define-key map "." 'notmuch-show-part-map)
emacs: Easy access to URLs mentioned in the current message Add a new binding when looking at messages, B, that prompts with a list of URLs found in the current message, if any. Open the one that is selected in a browser. amended by db: s/--browse-urls/-browse-urls/
2018-11-08 11:45:08 +01:00
(define-key map "B" 'notmuch-show-browse-urls)
emacs: Fix indentation. Fix the indentation of `notmuch-show-mode-map'.
2014-05-09 10:22:21 +02:00
map)
"Keymap for \"notmuch show\" buffers.")
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Mode
emacs: use define-derived-mode for defining modes. This sets up and runs all the correct hooks and reduces some redundancy.
2016-08-28 20:41:22 +02:00
(define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Major mode for viewing a thread with notmuch.
This buffer contains the results of the \"notmuch show\" command
for displaying a single thread of email from your email archives.
By default, various components of email messages, (citations,
signatures, already-read messages), are hidden. You can make
these parts visible by clicking with the mouse button or by
pressing RET after positioning the cursor on a hidden part, (for
emacs: Fix line-wrapping for help message of notmuch-show mode. This was previously wrapped for unsubtituted command names. It looks much better in the notmuch-help (available with '?') if wrapped according to the length of the substituted command names.
2010-08-20 00:09:55 +02:00
which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
Reading the thread sequentially is well-supported by pressing
emacs: Fix line-wrapping for help message of notmuch-show mode. This was previously wrapped for unsubtituted command names. It looks much better in the notmuch-help (available with '?') if wrapped according to the length of the substituted command names.
2010-08-20 00:09:55 +02:00
\\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
to the next message, or advance to the next thread (if already on
the last message of a thread).
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
Other commands are available to read or manipulate the thread
emacs: Fix line-wrapping for help message of notmuch-show mode. This was previously wrapped for unsubtituted command names. It looks much better in the notmuch-help (available with '?') if wrapped according to the length of the substituted command names.
2010-08-20 00:09:55 +02:00
more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
without scrolling through with \\[notmuch-show-advance-and-archive]).
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
fix sum moar typos [user-visible documentation in code] Various typo fixes in documentation within the code that can be made available to the user, (emacs function help strings, "notmuch help" output, notmuch man page, etc.). Signed-off-by: Pieter Praet <pieter@praet.org> Edited-by: Carl Worth <cworth@cworth.org> Restricted to just documentation and fixed fix of "comman" to "common" rather than "command".
2011-06-20 22:14:21 +02:00
You can add or remove arbitrary tags from the current message with
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
'\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
All currently available key bindings:
\\{notmuch-show-mode-map}"
emacs: Add unified refresh-this-buffer function This unifies the various refresh and poll-and-refresh functions we have for different modes. Now all modes bind "=" and "G" (except show, which doesn't bind "G" for some reason) to `notmuch-refresh-this-buffer' and `notmuch-poll-and-refresh-this-buffer', respectively.
2013-09-03 23:45:22 +02:00
(setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
emacs: Only set one variable per setq form It's a bit weird to avoid having to write the "(setq ... )" more than once, just because we can. In a language that uses '=' for the same purpose we also happily use that once per assignment. While there are no benefit to using just one 'setq' there are some drawbacks. It is not always clear on first what is a key and what a value and as a result it is easy to make a mistake. Also it becomes harder to comment out just one assignment.
2020-08-08 13:49:40 +02:00
(setq buffer-read-only t)
(setq truncate-lines t)
Add Emacs' imenu support in notmuch-show and notmuch-search Emacs' major modes can facilitate navigation in their buffers by supporting Imenu. In such major modes, launching Imenu (M-x imenu) makes Emacs display a list of items (e.g., function definitions in a code buffer). Selecting an item from this list moves point to this item. This patch adds Imenu support to both notmuch-show and notmuch-search buffers: * in notmuch-show, Imenu will present a list of all messages in the currently visible thread; * in notmuch-search, Imenu will present a list of all messages in the search buffer.
2017-06-12 15:30:10 +02:00
(setq imenu-prev-index-position-function
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
#'notmuch-show-imenu-prev-index-position-function)
Add Emacs' imenu support in notmuch-show and notmuch-search Emacs' major modes can facilitate navigation in their buffers by supporting Imenu. In such major modes, launching Imenu (M-x imenu) makes Emacs display a list of items (e.g., function definitions in a code buffer). Selecting an item from this list moves point to this item. This patch adds Imenu support to both notmuch-show and notmuch-search buffers: * in notmuch-show, Imenu will present a list of all messages in the currently visible thread; * in notmuch-search, Imenu will present a list of all messages in the search buffer.
2017-06-12 15:30:10 +02:00
(setq imenu-extract-index-name-function
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
#'notmuch-show-imenu-extract-index-name-function))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Tree commands
emacs: move the show entry to tree into show.el Move the keybinding and show specific helper from tree.el to show.el
2013-11-01 10:23:45 +01:00
(defun notmuch-tree-from-show-current-query ()
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Call notmuch tree with the current query."
emacs: move the show entry to tree into show.el Move the keybinding and show specific helper from tree.el to show.el
2013-11-01 10:23:45 +01:00
(interactive)
(notmuch-tree notmuch-show-thread-id
notmuch-show-query-context
(notmuch-show-get-message-id)))
Add a U binding to switch to unthreaded from other views We have shortcuts S and Z to let the user switch to Search view and Tree view with the current search. Add U to let the user switch to unthreaded view from the current search, and ensure that S and Z switch from unthreaded to search and tree veiew respectively.
2020-02-27 18:16:51 +01:00
(defun notmuch-unthreaded-from-show-current-query ()
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Call notmuch unthreaded with the current query."
Add a U binding to switch to unthreaded from other views We have shortcuts S and Z to let the user switch to Search view and Tree view with the current search. Add U to let the user switch to unthreaded view from the current search, and ensure that S and Z switch from unthreaded to search and tree veiew respectively.
2020-02-27 18:16:51 +01:00
(interactive)
(notmuch-unthreaded notmuch-show-thread-id
notmuch-show-query-context
(notmuch-show-get-message-id)))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Movement related functions.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-move-to-message-top ()
(goto-char (notmuch-show-message-top)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-move-to-message-bottom ()
(goto-char (notmuch-show-message-bottom)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; There's some strangeness here where a text property applied to a
;; region a->b is not found when point is at b. We walk backwards
;; until finding the property.
(defun notmuch-show-message-extent ()
emacs: Easy access to URLs mentioned in the current message Add a new binding when looking at messages, B, that prompts with a list of URLs found in the current message, if any. Open the one that is selected in a browser. amended by db: s/--browse-urls/-browse-urls/
2018-11-08 11:45:08 +01:00
"Return a cons cell containing the start and end buffer offset
of the current message."
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(let (r)
(save-excursion
(while (not (setq r (get-text-property (point) :notmuch-message-extent)))
(backward-char)))
r))
(defun notmuch-show-message-top ()
(car (notmuch-show-message-extent)))
(defun notmuch-show-message-bottom ()
(cdr (notmuch-show-message-extent)))
(defun notmuch-show-goto-message-next ()
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(let ((start (point)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(notmuch-show-move-to-message-bottom)
(if (not (eobp))
t
(goto-char start)
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
nil)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-goto-message-previous ()
(notmuch-show-move-to-message-top)
(if (bobp)
nil
(backward-char)
(notmuch-show-move-to-message-top)
t))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: add "*" binding for notmuch-show view The patch adds `notmuch-show-tag-all' function bound to "*" in notmuch-show view. The function is similar to the `notmuch-search-tag-all' function for the notmuch-search view: it changes tags for all messages in the current thread.
2012-02-05 08:13:48 +01:00
(defun notmuch-show-mapc (function)
"Iterate through all messages in the current thread with
`notmuch-show-goto-message-next' and call FUNCTION for side
effects."
(save-excursion
(goto-char (point-min))
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
(cl-loop do (funcall function)
while (notmuch-show-goto-message-next))))
emacs: add "*" binding for notmuch-show view The patch adds `notmuch-show-tag-all' function bound to "*" in notmuch-show view. The function is similar to the `notmuch-search-tag-all' function for the notmuch-search view: it changes tags for all messages in the current thread.
2012-02-05 08:13:48 +01:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Functions relating to the visibility of messages and their components.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-message-visible (props visible-p)
emacs: Eliminate buffer invisibility specs from show and wash Previously, all visibility in show buffers for headers, message bodies, and washed text was specified by generating one or more symbols for each region and creating overlays with their 'invisible property set to carefully crafted combinations of these symbols. Visibility was controlled not by modifying the overlays directly, but by adding and removing the generated symbols from a gigantic buffer invisibilty spec. This has myriad negative consequences. It's slow because Emacs' display engine has to traverse the buffer invisibility list for every overlay and, since every overlay has its own symbol, this makes rendering O(N^2) in the number of overlays. It composes poorly because symbol-type 'invisible properties are taken from the highest priority overlay over a given character (which is often ambiguous!), rather than being gathered from all overlays over a character. As a result, we have to include symbols related to message hiding in the wash code lest the wash overlays un-hide parts of hidden messages. It also requires various workarounds for isearch to properly open overlays, to set up buffer-invisibility-spec for remove-from-invisibility-spec to work right, and to explicitly refresh the display after updating the buffer invisibility spec. None of this is necessary. This patch converts show and wash to use simple boolean 'invisible properties and to not use the buffer invisibility spec. Rather than adding and removing generated symbols from the invisibility spec, the code now directly toggles the 'invisible property of the appropriate overlay. This speeds up rendering because the display engine only has to check the boolean values of the overlays over a character. It composes nicely because text will be invisible if *any* overlay over it has 'invisible t, which means we can overlap invisibility overlays with abandon. We no longer need any of the workarounds mentioned above. And it fixes a minor bug for free: now, when isearch opens a washed region, the button text will update to say "Click/Enter to hide" rather than remaining unchanged.
2012-12-18 07:40:10 +01:00
(overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(notmuch-show-set-prop :message-visible visible-p props))
(defun notmuch-show-headers-visible (props visible-p)
emacs: Eliminate buffer invisibility specs from show and wash Previously, all visibility in show buffers for headers, message bodies, and washed text was specified by generating one or more symbols for each region and creating overlays with their 'invisible property set to carefully crafted combinations of these symbols. Visibility was controlled not by modifying the overlays directly, but by adding and removing the generated symbols from a gigantic buffer invisibilty spec. This has myriad negative consequences. It's slow because Emacs' display engine has to traverse the buffer invisibility list for every overlay and, since every overlay has its own symbol, this makes rendering O(N^2) in the number of overlays. It composes poorly because symbol-type 'invisible properties are taken from the highest priority overlay over a given character (which is often ambiguous!), rather than being gathered from all overlays over a character. As a result, we have to include symbols related to message hiding in the wash code lest the wash overlays un-hide parts of hidden messages. It also requires various workarounds for isearch to properly open overlays, to set up buffer-invisibility-spec for remove-from-invisibility-spec to work right, and to explicitly refresh the display after updating the buffer invisibility spec. None of this is necessary. This patch converts show and wash to use simple boolean 'invisible properties and to not use the buffer invisibility spec. Rather than adding and removing generated symbols from the invisibility spec, the code now directly toggles the 'invisible property of the appropriate overlay. This speeds up rendering because the display engine only has to check the boolean values of the overlays over a character. It composes nicely because text will be invisible if *any* overlay over it has 'invisible t, which means we can overlap invisibility overlays with abandon. We no longer need any of the workarounds mentioned above. And it fixes a minor bug for free: now, when isearch opens a washed region, the button text will update to say "Click/Enter to hide" rather than remaining unchanged.
2012-12-18 07:40:10 +01:00
(overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(notmuch-show-set-prop :headers-visible visible-p props))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Functions for setting and getting attributes of the current message.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-set-message-properties (props)
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(save-excursion
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(notmuch-show-move-to-message-top)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(put-text-property (point) (+ (point) 1)
:notmuch-message-properties props)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-get-message-properties ()
emacs: Document notmuch-show-get-message-properties
2011-07-08 20:46:55 +02:00
"Return the properties of the current message as a plist.
Some useful entries are:
:headers - Property list containing the headers :Date, :Subject, :From, etc.
:body - Body of the message
:tags - Tags for this message"
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(save-excursion
(notmuch-show-move-to-message-top)
(get-text-property (point) :notmuch-message-properties)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Record part p-list in a text property This is similar to what we already do with the message p-list, though we apply the part's text property to the whole part's text, in contrast with the message p-list, which is (rather obscurely) only applied to the first character.
2013-05-30 03:13:45 +02:00
(defun notmuch-show-get-part-properties ()
"Return the properties of the innermost part containing point.
This is the part property list retrieved from the CLI. Signals
an error if there is no part containing point."
(or (get-text-property (point) :notmuch-part)
(error "No message part here")))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-set-prop (prop val &optional props)
(let ((inhibit-read-only t)
(props (or props
(notmuch-show-get-message-properties))))
(plist-put props prop val)
(notmuch-show-set-message-properties props)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-get-prop (prop &optional props)
emacs: tree/show remove duplicate function tree overrides notmuch-show-get-prop so that it can use many of the utility function directly. Now that tree is in mainline the version from tree can be moved to show and the original overridden show version dropped.
2014-06-07 11:51:08 +02:00
"Get property PROP from current message in show or tree mode.
It gets property PROP from PROPS or, if PROPS is nil, the current
message in either tree or show. This means that several utility
functions in notmuch-show can be used directly by notmuch-tree as
they just need the correct message properties."
emacs: avoid unnecessary let-bindings To some extend this is a personal preference, but the preference is strongly dependent on whether one is used to a language that makes it necessary to use variables like this. This makes it perfectly clear that we are first getting and then using a "foo": (use-foo (get-foo)) Sure this has to be read "inside out", but that's something one better gets used to quickly when dealing with lisp. I don't understand why one would want to write this instead: (let ((the-foo (get-foo))) (use-foo the-foo)) Both `get-foo' and `use-foo' are named in a way that make it very clear that we are dealing with a "foo". Storing the value in an additional variable `the-foo' does not make this any more clear. On the contrary I makes the reader wonder why the author choose to use a variable. Is the value used more than once? Is the value being retrieved in one context and then used in another (e.g. when the current buffer changes)?
2021-01-10 15:01:06 +01:00
(plist-get (or props
(cond ((eq major-mode 'notmuch-show-mode)
(notmuch-show-get-message-properties))
((eq major-mode 'notmuch-tree-mode)
(notmuch-tree-get-message-properties))
(t nil)))
prop))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: `notmuch-show-get-message-id': optionally return Message-Id sans prefix * emacs/notmuch-show.el (notmuch-show-get-message-id): Add optional arg BARE. When non-nil, return a Message-Id without quotes and prefix, thus obviating the need to strip them off again in various places. (notmuch-show-stash-message-id-stripped): Update wrt changes in `notmuch-show-get-message-id'.
2012-02-19 21:50:25 +01:00
(defun notmuch-show-get-message-id (&optional bare)
emacs: Escape all message ID queries This adds a lib function to turn a message ID into a properly escaped message ID query and uses this function wherever we previously hand-constructed ID queries. Wherever this new function is used, documentation has been clarified to refer to "id: queries" instead of "message IDs". This fixes the broken test introduced by the previous patch.
2012-03-27 03:37:16 +02:00
"Return an id: query for the Message-Id of the current message.
emacs: `notmuch-show-get-message-id': optionally return Message-Id sans prefix * emacs/notmuch-show.el (notmuch-show-get-message-id): Add optional arg BARE. When non-nil, return a Message-Id without quotes and prefix, thus obviating the need to strip them off again in various places. (notmuch-show-stash-message-id-stripped): Update wrt changes in `notmuch-show-get-message-id'.
2012-02-19 21:50:25 +01:00
If optional argument BARE is non-nil, return
emacs: Escape all message ID queries This adds a lib function to turn a message ID into a properly escaped message ID query and uses this function wherever we previously hand-constructed ID queries. Wherever this new function is used, documentation has been clarified to refer to "id: queries" instead of "message IDs". This fixes the broken test introduced by the previous patch.
2012-03-27 03:37:16 +02:00
the Message-Id without id: prefix and escaping."
emacs: `notmuch-show-get-message-id': optionally return Message-Id sans prefix * emacs/notmuch-show.el (notmuch-show-get-message-id): Add optional arg BARE. When non-nil, return a Message-Id without quotes and prefix, thus obviating the need to strip them off again in various places. (notmuch-show-stash-message-id-stripped): Update wrt changes in `notmuch-show-get-message-id'.
2012-02-19 21:50:25 +01:00
(if bare
(notmuch-show-get-prop :id)
emacs: Escape all message ID queries This adds a lib function to turn a message ID into a properly escaped message ID query and uses this function wherever we previously hand-constructed ID queries. Wherever this new function is used, documentation has been clarified to refer to "id: queries" instead of "message IDs". This fixes the broken test introduced by the previous patch.
2012-03-27 03:37:16 +02:00
(notmuch-id-to-query (notmuch-show-get-prop :id))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: add "*" binding for notmuch-show view The patch adds `notmuch-show-tag-all' function bound to "*" in notmuch-show view. The function is similar to the `notmuch-search-tag-all' function for the notmuch-search view: it changes tags for all messages in the current thread.
2012-02-05 08:13:48 +01:00
(defun notmuch-show-get-messages-ids ()
emacs: Escape all message ID queries This adds a lib function to turn a message ID into a properly escaped message ID query and uses this function wherever we previously hand-constructed ID queries. Wherever this new function is used, documentation has been clarified to refer to "id: queries" instead of "message IDs". This fixes the broken test introduced by the previous patch.
2012-03-27 03:37:16 +02:00
"Return all id: queries of messages in the current thread."
emacs: add "*" binding for notmuch-show view The patch adds `notmuch-show-tag-all' function bound to "*" in notmuch-show view. The function is similar to the `notmuch-search-tag-all' function for the notmuch-search view: it changes tags for all messages in the current thread.
2012-02-05 08:13:48 +01:00
(let ((message-ids))
(notmuch-show-mapc
(lambda () (push (notmuch-show-get-message-id) message-ids)))
message-ids))
(defun notmuch-show-get-messages-ids-search ()
"Return a search string for all message ids of messages in the
current thread."
(mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; dme: Would it make sense to use a macro for many of these?
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-get-filename ()
"Return the filename of the current message."
emacs/show: provide a more friendly function to get duplicate num There is not much code here, but at least we can fix the indexing as 1 based.
2022-08-04 13:48:07 +02:00
(let ((duplicate (notmuch-show-get-duplicate)))
emacs: update notmuch-show-get-filename to handle duplicates This fixes one of the bugs reported by Gregor in [1]. [1]: id:87edxw8jp4.fsf@no.workgroup
2022-08-04 13:08:33 +02:00
(nth (1- duplicate) (notmuch-show-get-prop :filename))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: remove some code duplication in notmuch-show Add optional props argument to `notmuch-show-get-header'. Use it to get headers in `notmuch-show-insert-part-multipart/signed' and `notmuch-show-insert-part-multipart/encrypted'.
2011-11-25 23:23:30 +01:00
(defun notmuch-show-get-header (header &optional props)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Return the named header of the current message, if any."
emacs: remove some code duplication in notmuch-show Add optional props argument to `notmuch-show-get-header'. Use it to get headers in `notmuch-show-insert-part-multipart/signed' and `notmuch-show-insert-part-multipart/encrypted'.
2011-11-25 23:23:30 +01:00
(plist-get (notmuch-show-get-prop :headers props) header))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-get-cc ()
(notmuch-show-get-header :Cc))
(defun notmuch-show-get-date ()
(notmuch-show-get-header :Date))
emacs/show: provide a more friendly function to get duplicate num There is not much code here, but at least we can fix the indexing as 1 based.
2022-08-04 13:48:07 +02:00
(defun notmuch-show-get-duplicate ()
;; if no duplicate property exists, assume first file
(or (notmuch-show-get-prop :duplicate) 1))
emacs: with prefix argument, notmuch-show-stash-date stashes timestamp Using timestamp of a message is useful in many Xapian queries.
2017-04-08 20:33:43 +02:00
(defun notmuch-show-get-timestamp ()
(notmuch-show-get-prop :timestamp))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-get-from ()
(notmuch-show-get-header :From))
(defun notmuch-show-get-subject ()
(notmuch-show-get-header :Subject))
(defun notmuch-show-get-to ()
(notmuch-show-get-header :To))
emacs: Improved printing support. Add various functions to print notmuch messages and tie them together with a simple frontend. Add a binding ('#') in `notmuch-show-mode' to print the current message. one trailing space removed by db.
2012-01-18 09:00:21 +01:00
(defun notmuch-show-get-depth ()
(notmuch-show-get-prop :depth))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-set-tags (tags)
"Set the tags of the current message."
(notmuch-show-set-prop :tags tags)
(notmuch-show-update-tags tags))
(defun notmuch-show-get-tags ()
"Return the tags of the current message."
(notmuch-show-get-prop :tags))
(defun notmuch-show-message-visible-p ()
"Is the current message visible?"
(notmuch-show-get-prop :message-visible))
(defun notmuch-show-headers-visible-p ()
"Are the headers of the current message visible?"
(notmuch-show-get-prop :headers-visible))
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-mark-read 'notmuch-prefix-doc
"Mark the current message as unread.")
emacs: add support for reversing notmuch-show-mark-read tag changes Since marking a message as read can now be a user customized set of tag changes, make reversing this easier. Allow a prefix argument to notmuch-show-mark-read to reverse the marking as read, similar to the unarchiving in notmuch-show-archive-message. While at it, update the relevant documentation to match that of other automatic tagging (i.e. archive and reply).
2012-09-06 17:32:42 +02:00
(defun notmuch-show-mark-read (&optional unread)
"Mark the current message as read.
Mark the current message as read by applying the tag changes in
`notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
default). If a prefix argument is given, the message will be
marked as unread, i.e. the tag changes in
`notmuch-show-mark-read-tags' will be reversed."
(interactive "P")
notmuch-show: add notmuch-show-mark-read-tags option The `notmuch-show-mark-read-tags' lists tags that are to be applied when message is read. By default, the only value is "-unread" which will remove the unread tag. Among other uses, this variable can be used to stop notmuch-show from modifying tags when message is shown (by setting the variable to an empty list).
2012-08-21 15:13:36 +02:00
(when notmuch-show-mark-read-tags
emacs: add support for reversing notmuch-show-mark-read tag changes Since marking a message as read can now be a user customized set of tag changes, make reversing this easier. Allow a prefix argument to notmuch-show-mark-read to reverse the marking as read, similar to the unarchiving in notmuch-show-archive-message. While at it, update the relevant documentation to match that of other automatic tagging (i.e. archive and reply).
2012-09-06 17:32:42 +02:00
(apply 'notmuch-show-tag-message
(notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(defun notmuch-show-seen-current-message (_start _end)
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
"Mark the current message read if it is open.
We only mark it read once: if it is changed back then that is a
user decision and we should not override it."
(when (and (notmuch-show-message-visible-p)
(not (notmuch-show-get-prop :seen)))
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
(notmuch-show-mark-read)
(notmuch-show-set-prop :seen t)))
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
emacs: show: improve handling of mark read tagging errors Previously if a marking read tag change (i.e., removing the unread tag) failed for some reason, such as a locked database, then no more mark read tag changes would be attempted in that buffer. This handles the error more gracefully. There is not much we can do yet about dealing with the error itself, and marking read is probably not important enough to warrant keeping a queue of pending changes or anything. However this commit changes it so that - we do try and make future mark read tag changes. - we display the tag state correctly: i.e. we don't display the tag as deleted (no strike through) - and since we know the tag change failed we can try to mark this message read in the future. Indeed, since the code uses the post-command hook we will try again on the next keypress (unless the user has left the message). We indicate to the user that these mark read tag changes may have failed in the header-line.
2016-06-09 11:54:10 +02:00
(defvar notmuch-show--seen-has-errored nil)
(make-variable-buffer-local 'notmuch-show--seen-has-errored)
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(defun notmuch-show-command-hook ()
(when (eq major-mode 'notmuch-show-mode)
;; We need to redisplay to get window-start and window-end correct.
(redisplay)
(save-excursion
emacs: deal with unused lexical arguments and variables The previous commit switched to lexical-binding but without dealing with the new warnings about unused lexical arguments and variables. This commit deals with most of them, in most cases by either removing leftover bindings that are actually unnecessary, or by marking certain arguments as "known to be unused" by prefixing their names with "_". In the case of the functions named `notmuch-show-insert-...' the amount of silencing that is required is a bit extreme and we might want to investigate if there is a better way. In the case of `notmuch-mua-mail', ignoring CONTINUE means that we do not fully follow the intended behavior described in `compose-mail's doc-string.
2021-01-10 15:00:48 +01:00
(condition-case nil
emacs: show: improve handling of mark read tagging errors Previously if a marking read tag change (i.e., removing the unread tag) failed for some reason, such as a locked database, then no more mark read tag changes would be attempted in that buffer. This handles the error more gracefully. There is not much we can do yet about dealing with the error itself, and marking read is probably not important enough to warrant keeping a queue of pending changes or anything. However this commit changes it so that - we do try and make future mark read tag changes. - we display the tag state correctly: i.e. we don't display the tag as deleted (no strike through) - and since we know the tag change failed we can try to mark this message read in the future. Indeed, since the code uses the post-command hook we will try again on the next keypress (unless the user has left the message). We indicate to the user that these mark read tag changes may have failed in the header-line.
2016-06-09 11:54:10 +02:00
(funcall notmuch-show-mark-read-function (window-start) (window-end))
((debug error)
(unless notmuch-show--seen-has-errored
emacs: do not quote self-quoting t
2020-11-16 22:28:41 +01:00
(setq notmuch-show--seen-has-errored t)
emacs: show: improve handling of mark read tagging errors Previously if a marking read tag change (i.e., removing the unread tag) failed for some reason, such as a locked database, then no more mark read tag changes would be attempted in that buffer. This handles the error more gracefully. There is not much we can do yet about dealing with the error itself, and marking read is probably not important enough to warrant keeping a queue of pending changes or anything. However this commit changes it so that - we do try and make future mark read tag changes. - we display the tag state correctly: i.e. we don't display the tag as deleted (no strike through) - and since we know the tag change failed we can try to mark this message read in the future. Indeed, since the code uses the post-command hook we will try again on the next keypress (unless the user has left the message). We indicate to the user that these mark read tag changes may have failed in the header-line.
2016-06-09 11:54:10 +02:00
(setq header-line-format
(concat header-line-format
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(propertize
" [some mark read tag changes may have failed]"
'face font-lock-warning-face)))))))))
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
emacs: add a filter option to show Show the current thread with a different filter (i.e., open messages in the thread matching the new query). Bound to 'l' for "limit". Note that it is not the same as filter in search mode as it replaces the existing query rather than ANDing with it (but it does keep the thread-id part of the query).
2015-06-13 10:08:09 +02:00
(defun notmuch-show-filter-thread (query)
"Filter or LIMIT the current thread based on a new query string.
Reshows the current thread with matches defined by the new query-string."
(interactive (list (notmuch-read-query "Filter thread: ")))
(let ((msg-id (notmuch-show-get-message-id)))
emacs: use string-empty-p
2021-01-10 15:01:09 +01:00
(setq notmuch-show-query-context (if (string-empty-p query) nil query))
emacs: add a filter option to show Show the current thread with a different filter (i.e., open messages in the thread matching the new query). Bound to 'l' for "limit". Note that it is not the same as filter in search mode as it replaces the existing query rather than ANDing with it (but it does keep the thread-id part of the query).
2015-06-13 10:08:09 +02:00
(notmuch-show-refresh-view t)
(notmuch-show-goto-message msg-id)))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Functions for getting attributes of several messages in the current thread.
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
(defun notmuch-show-get-message-ids-for-open-messages ()
emacs: Escape all message ID queries This adds a lib function to turn a message ID into a properly escaped message ID query and uses this function wherever we previously hand-constructed ID queries. Wherever this new function is used, documentation has been clarified to refer to "id: queries" instead of "message IDs". This fixes the broken test introduced by the previous patch.
2012-03-27 03:37:16 +02:00
"Return a list of all id: queries for open messages in the current thread."
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
(save-excursion
(let (message-ids done)
(goto-char (point-min))
(while (not done)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (notmuch-show-message-visible-p)
(setq message-ids
(append message-ids (list (notmuch-show-get-message-id)))))
emacs: Closing parenthesis go on the same line
2020-08-08 13:49:39 +02:00
(setq done (not (notmuch-show-goto-message-next))))
message-ids)))
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Commands typically bound to keys.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: breakout notmuch-show-advance functionality from notmuch-show-advance-and-archive This patch breaks out much of the functionality of notmuch-show-advance-and-archive into a new function: notmuch-show-advance. This new function does all the advancing through a show buffer that notmuch-show-advance-and-archive did, without all the invasive thread archiving. The return value of notmuch-show-advance is nil if the bottom of the thread is not reached, and t if it is. notmuch-show-advance-and-archive is modified to just call notmuch-show-advance, and then call notmuch-show-archive-thread if the return value is true. In this way the previous functionality of notmuch-show-advance-and-archive is preserved. This provides a way for people to rebind the space bar to a more sane function if they don't like the default behavior.
2011-11-13 22:16:48 +01:00
(defun notmuch-show-advance ()
"Advance through thread.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
If the current message in the thread is not yet fully visible,
scroll by a near screenful to read more of the message.
Otherwise, (the end of the current message is already within the
emacs: breakout notmuch-show-advance functionality from notmuch-show-advance-and-archive This patch breaks out much of the functionality of notmuch-show-advance-and-archive into a new function: notmuch-show-advance. This new function does all the advancing through a show buffer that notmuch-show-advance-and-archive did, without all the invasive thread archiving. The return value of notmuch-show-advance is nil if the bottom of the thread is not reached, and t if it is. notmuch-show-advance-and-archive is modified to just call notmuch-show-advance, and then call notmuch-show-archive-thread if the return value is true. In this way the previous functionality of notmuch-show-advance-and-archive is preserved. This provides a way for people to rebind the space bar to a more sane function if they don't like the default behavior.
2011-11-13 22:16:48 +01:00
current window), advance to the next open message."
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(interactive)
emacs: improve hidden signatures handling in notmuch-show-advance-and-archive Use `previous-single-char-property-change' instead of going through each character by hand and testing it's visibility. This fixes `notmuch-show-advance-and-archive' to work for the last message in thread with hidden signature.
2011-11-06 10:03:59 +01:00
(let* ((end-of-this-message (notmuch-show-message-bottom))
emacs: breakout notmuch-show-advance functionality from notmuch-show-advance-and-archive This patch breaks out much of the functionality of notmuch-show-advance-and-archive into a new function: notmuch-show-advance. This new function does all the advancing through a show buffer that notmuch-show-advance-and-archive did, without all the invasive thread archiving. The return value of notmuch-show-advance is nil if the bottom of the thread is not reached, and t if it is. notmuch-show-advance-and-archive is modified to just call notmuch-show-advance, and then call notmuch-show-archive-thread if the return value is true. In this way the previous functionality of notmuch-show-advance-and-archive is preserved. This provides a way for people to rebind the space bar to a more sane function if they don't like the default behavior.
2011-11-13 22:16:48 +01:00
(visible-end-of-this-message (1- end-of-this-message))
(ret nil))
emacs: improve hidden signatures handling in notmuch-show-advance-and-archive Use `previous-single-char-property-change' instead of going through each character by hand and testing it's visibility. This fixes `notmuch-show-advance-and-archive' to work for the last message in thread with hidden signature.
2011-11-06 10:03:59 +01:00
(while (invisible-p visible-end-of-this-message)
(setq visible-end-of-this-message
emacs: fix off-by-one bug in notmuch-show-archive Text properties change between characters; prev-s-c-property-change returns the position after the change. Thus, it is still inside the invisible region.
2011-12-22 15:24:20 +01:00
(max (point-min)
(1- (previous-single-char-property-change
visible-end-of-this-message 'invisible)))))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(cond
;; Ideally we would test `end-of-this-message' against the result
;; of `window-end', but that doesn't account for the fact that
emacs: improve hidden signatures handling in notmuch-show-advance-and-archive Use `previous-single-char-property-change' instead of going through each character by hand and testing it's visibility. This fixes `notmuch-show-advance-and-archive' to work for the last message in thread with hidden signature.
2011-11-06 10:03:59 +01:00
;; the end of the message might be hidden.
((and visible-end-of-this-message
(> visible-end-of-this-message (window-end)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; The bottom of this message is not visible - scroll.
(scroll-up nil))
((not (= end-of-this-message (point-max)))
;; This is not the last message - move to the next visible one.
(notmuch-show-next-open-message))
emacs: Don't move to the next thread unless the cursor is at the end of the buffer. When using the spacebar to scroll through a thread, hitting 'space' when the bottom of the last message is visible should take the cursor to the end of the buffer rather than immediately archiving the thread and moving to the next thread.
2012-01-31 09:01:54 +01:00
((not (= (point) (point-max)))
;; This is the last message, but the cursor is not at the end of
;; the buffer. Move it there.
(goto-char (point-max)))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(t
emacs: breakout notmuch-show-advance functionality from notmuch-show-advance-and-archive This patch breaks out much of the functionality of notmuch-show-advance-and-archive into a new function: notmuch-show-advance. This new function does all the advancing through a show buffer that notmuch-show-advance-and-archive did, without all the invasive thread archiving. The return value of notmuch-show-advance is nil if the bottom of the thread is not reached, and t if it is. notmuch-show-advance-and-archive is modified to just call notmuch-show-advance, and then call notmuch-show-archive-thread if the return value is true. In this way the previous functionality of notmuch-show-advance-and-archive is preserved. This provides a way for people to rebind the space bar to a more sane function if they don't like the default behavior.
2011-11-13 22:16:48 +01:00
;; This is the last message - change the return value
(setq ret t)))
ret))
(defun notmuch-show-advance-and-archive ()
"Advance through thread and archive.
This command is intended to be one of the simplest ways to
process a thread of email. It works exactly like
notmuch-show-advance, in that it scrolls through messages in a
show buffer, except that when it gets to the end of the buffer it
emacs: add `notmuch-archive-tags' cross references in docstrings Several function docstrings refer to behaviour in docstrings that is really controlled by notmuch-archive-tags. Add cross references, and replace hardcoding.
2013-06-02 16:29:17 +02:00
archives the entire current thread, (apply changes in
`notmuch-archive-tags'), kills the buffer, and displays the next
emacs: breakout notmuch-show-advance functionality from notmuch-show-advance-and-archive This patch breaks out much of the functionality of notmuch-show-advance-and-archive into a new function: notmuch-show-advance. This new function does all the advancing through a show buffer that notmuch-show-advance-and-archive did, without all the invasive thread archiving. The return value of notmuch-show-advance is nil if the bottom of the thread is not reached, and t if it is. notmuch-show-advance-and-archive is modified to just call notmuch-show-advance, and then call notmuch-show-archive-thread if the return value is true. In this way the previous functionality of notmuch-show-advance-and-archive is preserved. This provides a way for people to rebind the space bar to a more sane function if they don't like the default behavior.
2011-11-13 22:16:48 +01:00
thread from the search from which this thread was originally
shown."
(interactive)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (notmuch-show-advance)
(notmuch-show-archive-thread-then-next)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-rewind ()
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
"Backup through the thread (reverse scrolling compared to \
\\[notmuch-show-advance-and-archive]).
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
Specifically, if the beginning of the previous email is fewer
than `window-height' lines from the current point, move to it
just like `notmuch-show-previous-message'.
Otherwise, just scroll down a screenful of the current message.
This command does not modify any message tags, (it does not undo
any effects from previous calls to
`notmuch-show-advance-and-archive'."
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(interactive)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(let ((start-of-message (notmuch-show-message-top))
(start-of-window (window-start)))
(cond
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
;; Either this message is properly aligned with the start of the
;; window or the start of this message is not visible on the
;; screen - scroll.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
((or (= start-of-message start-of-window)
(< start-of-message start-of-window))
(scroll-down)
;; If a small number of lines from the previous message are
;; visible, realign so that the top of the current message is at
;; the top of the screen.
emacs: globally replace non-branching "(if COND (progn ..." with "(when ..." Less code, same results, without sacrificing readability.
2012-02-01 14:50:00 +01:00
(when (<= (count-screen-lines (window-start) start-of-message)
next-screen-context-lines)
(goto-char (notmuch-show-message-top))
(notmuch-show-message-adjust))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
;; Move to the top left of the window.
(goto-char (window-start)))
(t
;; Move to the previous message.
(notmuch-show-previous-message)))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
emacs: Allow the user to choose the "From" address when replying to a message When pressing C-u r, the user will be prompted for the identity to use.
2011-05-26 10:41:33 +02:00
(defun notmuch-show-reply (&optional prompt-for-sender)
emacs: add support for replying just to the sender Provide reply to sender counterparts to the search and show reply functions. Add key binding 'R' to reply to sender, while keeping 'r' as reply to all, both in search and show views. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-14 15:46:17 +01:00
"Reply to the sender and all recipients of the current message."
emacs: Allow the user to choose the "From" address when replying to a message When pressing C-u r, the user will be prompted for the identity to use.
2011-05-26 10:41:33 +02:00
(interactive "P")
emacs/reply: reply to correct duplicate Essentially we just need to arrange to pass the right --duplicate argument to notmuch reply. As a side-effect, correct the previously unused value of EXPECTED in T453-emacs-reply.sh.
2022-07-01 23:45:48 +02:00
(notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t
(notmuch-show-get-prop :duplicate)))
emacs: add support for replying just to the sender Provide reply to sender counterparts to the search and show reply functions. Add key binding 'R' to reply to sender, while keeping 'r' as reply to all, both in search and show views. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-14 15:46:17 +01:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
emacs: add support for replying just to the sender Provide reply to sender counterparts to the search and show reply functions. Add key binding 'R' to reply to sender, while keeping 'r' as reply to all, both in search and show views. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-14 15:46:17 +01:00
(defun notmuch-show-reply-sender (&optional prompt-for-sender)
"Reply to the sender of the current message."
(interactive "P")
emacs/reply: reply to correct duplicate Essentially we just need to arrange to pass the right --duplicate argument to notmuch reply. As a side-effect, correct the previously unused value of EXPECTED in T453-emacs-reply.sh.
2022-07-01 23:45:48 +02:00
(notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil
(notmuch-show-get-prop :duplicate)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-forward-message 'notmuch-prefix-doc
"... and prompt for sender")
emacs: Allow the user to choose the "From" address when forwarding a message When pressing C-u f, the user will be prompted for the identity to use.
2011-05-26 10:41:32 +02:00
(defun notmuch-show-forward-message (&optional prompt-for-sender)
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Forward the current message."
emacs: Allow the user to choose the "From" address when forwarding a message When pressing C-u f, the user will be prompted for the identity to use.
2011-05-26 10:41:32 +02:00
(interactive "P")
emacs: `notmuch-show-forward-message' can use `notmuch-mua-new-forward-messages' Which allows `notmuch-mua-new-forward-message' to be removed.
2016-02-08 12:34:22 +01:00
(notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
prompt-for-sender))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Add `notmuch-show-forward-open-messages'. Add a function to forward all open messages in the current view of a thread. Bind this to "F".
2016-02-08 12:34:21 +01:00
(put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
"... and prompt for sender")
(defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
"Forward the currently open messages."
(interactive "P")
(let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
(unless open-messages
(error "No open messages to forward."))
(notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
emacs: add function to resend message to new recipients The new function notmuch-show-message-resend re-sends message to new recipients using #'message-resend. Recipients are read from minibuffer as a comma-separated string (with some keyboard support including tab completion). Final confirmation before sending is asked.
2016-05-07 21:03:11 +02:00
(defun notmuch-show-resend-message (addresses)
"Resend the current message."
(interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
(when (y-or-n-p (concat "Confirm resend to " addresses " "))
(notmuch-show-view-raw-message)
(message-resend addresses)
(notmuch-bury-or-kill-this-buffer)))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
(defun notmuch-show-message-adjust ()
(recenter 0))
emacs: add option to show-next-{, open-}message functions to pop out to parent buffer if at end This will allow for keybindings that achieve a smoother message processing flow by reducing the number of key presses needed for most common operations.
2012-01-25 01:06:20 +01:00
(defun notmuch-show-next-message (&optional pop-at-end)
"Show the next message.
If a prefix argument is given and this is the last message in the
thread, navigate to the next thread in the parent search buffer."
(interactive "P")
emacs: Push the cursor to point-max on `n' or `N' at the end of a thread Sebastian pointed out that the pre-JSON UI would move the cursor to the end of the buffer if `n' or `N' is hit when on the last (unread) message. Mimic that behaviour in the new UI.
2010-04-22 13:20:16 +02:00
(if (notmuch-show-goto-message-next)
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(notmuch-show-message-adjust)
emacs: add option to show-next-{, open-}message functions to pop out to parent buffer if at end This will allow for keybindings that achieve a smoother message processing flow by reducing the number of key presses needed for most common operations.
2012-01-25 01:06:20 +01:00
(if pop-at-end
(notmuch-show-next-thread)
(goto-char (point-max)))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-previous-message ()
emacs: Make moving to the previous message move to the previous boundary Previously, notmuch-show-previous-message would move to the beginning of the message before the message containing point. This patch makes it instead move to the previous message *boundary*. That is, if point isn't already at the beginning of the message, it moves to the beginning of the current message. This is consistent with notmuch-show-next-message, which can be thought of as moving to the next message boundary. Several people have expressed a preference for this.
2012-07-14 05:47:48 +02:00
"Show the previous message or the start of the current message."
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(interactive)
emacs: Make moving to the previous message move to the previous boundary Previously, notmuch-show-previous-message would move to the beginning of the message before the message containing point. This patch makes it instead move to the previous message *boundary*. That is, if point isn't already at the beginning of the message, it moves to the beginning of the current message. This is consistent with notmuch-show-next-message, which can be thought of as moving to the next message boundary. Several people have expressed a preference for this.
2012-07-14 05:47:48 +02:00
(if (= (point) (notmuch-show-message-top))
(notmuch-show-goto-message-previous)
(notmuch-show-move-to-message-top))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(notmuch-show-message-adjust))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: add option to show-next-{, open-}message functions to pop out to parent buffer if at end This will allow for keybindings that achieve a smoother message processing flow by reducing the number of key presses needed for most common operations.
2012-01-25 01:06:20 +01:00
(defun notmuch-show-next-open-message (&optional pop-at-end)
"Show the next open message.
If a prefix argument is given and this is the last open message
in the thread, navigate to the next thread in the parent search
emacs: make show view a/A/x/X key bindings more consistent Modify the show view key bindings as follows to make them more consistent: 'a' = Archive current message, then move to next message, or show next thread from search if at the last message in thread. 'A' = Archive each message in thread, then show next thread from search. 'x' = Archive current message, then move to next message, or exit back to search results if at the last message in thread. 'X' = Archive each message in thread, then exit back to search results. The changes make the key bindings more consistent in two ways: 1) 'a'/'A' both advance to the next thread like 'a' used to. 2) 'x' operates on messages and 'X' on threads like 'a'/'A'.
2012-01-31 18:29:06 +01:00
buffer. Return t if there was a next open message in the thread
to show, nil otherwise."
emacs: add option to show-next-{, open-}message functions to pop out to parent buffer if at end This will allow for keybindings that achieve a smoother message processing flow by reducing the number of key presses needed for most common operations.
2012-01-25 01:06:20 +01:00
(interactive "P")
emacs: Push the cursor to point-max on `n' or `N' at the end of a thread Sebastian pointed out that the pre-JSON UI would move the cursor to the end of the buffer if `n' or `N' is hit when on the last (unread) message. Mimic that behaviour in the new UI.
2010-04-22 13:20:16 +02:00
(let (r)
(while (and (setq r (notmuch-show-goto-message-next))
(not (notmuch-show-message-visible-p))))
(if r
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(notmuch-show-message-adjust)
emacs: add option to show-next-{, open-}message functions to pop out to parent buffer if at end This will allow for keybindings that achieve a smoother message processing flow by reducing the number of key presses needed for most common operations.
2012-01-25 01:06:20 +01:00
(if pop-at-end
(notmuch-show-next-thread)
emacs: make show view a/A/x/X key bindings more consistent Modify the show view key bindings as follows to make them more consistent: 'a' = Archive current message, then move to next message, or show next thread from search if at the last message in thread. 'A' = Archive each message in thread, then show next thread from search. 'x' = Archive current message, then move to next message, or exit back to search results if at the last message in thread. 'X' = Archive each message in thread, then exit back to search results. The changes make the key bindings more consistent in two ways: 1) 'a'/'A' both advance to the next thread like 'a' used to. 2) 'x' operates on messages and 'X' on threads like 'a'/'A'.
2012-01-31 18:29:06 +01:00
(goto-char (point-max))))
r))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(defun notmuch-show-next-matching-message ()
"Show the next matching message."
(interactive)
(let (r)
(while (and (setq r (notmuch-show-goto-message-next))
(not (notmuch-show-get-prop :match))))
(if r
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(notmuch-show-message-adjust)
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(goto-char (point-max)))))
emacs-show: open excluded matches if no other matches Currently emacs show does not open matching but excluded messages. This is normally the desired behaviour but is probably not ideal if only excluded messages match. This patch opens all the matching (necessarily excluded) messages in this case and goes to the first one.
2012-03-15 19:28:10 +01:00
(defun notmuch-show-open-if-matched ()
"Open a message if it is matched (whether or not excluded)."
(let ((props (notmuch-show-get-message-properties)))
(notmuch-show-message-visible props (plist-get props :match))))
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(defun notmuch-show-goto-first-wanted-message ()
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Move to the first open message and mark it read."
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(goto-char (point-min))
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(unless (notmuch-show-message-visible-p)
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(notmuch-show-next-open-message))
(when (eobp)
emacs-show: open excluded matches if no other matches Currently emacs show does not open matching but excluded messages. This is normally the desired behaviour but is probably not ideal if only excluded messages match. This patch opens all the matching (necessarily excluded) messages in this case and goes to the first one.
2012-03-15 19:28:10 +01:00
;; There are no matched non-excluded messages so open all matched
;; (necessarily excluded) messages and go to the first.
(notmuch-show-mapc 'notmuch-show-open-if-matched)
(force-window-update)
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
(goto-char (point-min))
emacs: show: add an update seen function to post-command-hook Add a function for updating seen messages to the post-command-hook. This function calls a customizable (by eg defcustom) function with parameters the start and end of the current window and that function can decide what to mark read based on that and the current point. Since this is in the post-command-hook it should get called after most user actions (exceptions include user resizing the window) so it should be possible to make sure the seen status gets updated whether the user uses notmuch commands like next-message or normal emacs commands like scroll-up. It removes all of the old mark read/seen points but introduces a simple example function that just marks the current message read if it is open. This function has one small subtlety: it makes sure it doesn't mark the same message read twice (in the same instance of the same buffer); otherwise the post-command-hook makes it impossible for a user to manually mark a message unread. This fixes the current bugs (imo) that closed messages can be marked read, and that opening a closed message does not mark it read. Another advantage of using the post-command-hook any programmatic use with point passing through a message will not mark it read.
2014-05-09 02:20:08 +02:00
(unless (notmuch-show-message-visible-p)
emacs-show: open excluded matches if no other matches Currently emacs show does not open matching but excluded messages. This is normally the desired behaviour but is probably not ideal if only excluded messages match. This patch opens all the matching (necessarily excluded) messages in this case and goes to the first one.
2012-03-15 19:28:10 +01:00
(notmuch-show-next-open-message))))
emacs: show: recognize the exclude flag. Show mode will recognize the exclude flag by not opening excluding messages by default, and will start at the first matching non-excluded message. If there are no matching non-excluded messages it will go to the first matching (necessarily excluded) message.
2012-03-01 23:30:44 +01:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-previous-open-message ()
emacs: fix show-previous-message doc string
2012-01-25 01:06:23 +01:00
"Show the previous open message."
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(interactive)
emacs: Make moving to the previous message move to the previous boundary Previously, notmuch-show-previous-message would move to the beginning of the message before the message containing point. This patch makes it instead move to the previous message *boundary*. That is, if point isn't already at the beginning of the message, it moves to the beginning of the current message. This is consistent with notmuch-show-next-message, which can be thought of as moving to the next message boundary. Several people have expressed a preference for this.
2012-07-14 05:47:48 +02:00
(while (and (if (= (point) (notmuch-show-message-top))
(notmuch-show-goto-message-previous)
(notmuch-show-move-to-message-top))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(not (notmuch-show-message-visible-p))))
(notmuch-show-message-adjust))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-view-raw-message ()
emacs: Fix coding system in `notmuch-show-view-raw-message' This fixes the known-broken test of viewing 8bit messages added by the previous commit.
2014-04-21 20:37:40 +02:00
"View the original source of the current message."
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(interactive)
emacs: Use `view-mode' when examining raw messages. Explained-by: Carl Worth: This gives convenient keybindings for navigating the file and for quitting from the buffer, (since, with a raw message file the user will generally want to just view the message, not edit it).
2010-11-15 15:21:53 +01:00
(let* ((id (notmuch-show-get-message-id))
emacs: add duplicate support to notmuch-show-view-raw-message This fixes one of the bugs reported by Gregor in [1] [1]: id:87edxw8jp4.fsf@no.workgroup
2022-08-04 13:48:08 +02:00
(duplicate (notmuch-show-get-duplicate))
(args (if (> duplicate 1)
(list (format "--duplicate=%d" duplicate) id)
(list id)))
(buf (get-buffer-create (format "*notmuch-raw-%s-%d*" id duplicate)))
emacs: notmuch-show-view-raw-message clears buffer, makes it read-only notmuch-show-view-raw-message() re-uses buffer created with same name (same Message-Id:) but it did not erase it before filling. If this ever happened, there were duplicated (potentially overlapping) content in the buffer. Now this is fixed. Apparently since emacs 24.5 the (view-buffer) makes the buffer read-only; so this problem would not have happened there, just that notmuch-show-view-raw-message() failed. This is fixed by setting inhibit-read-only t before erasing and filling the buffer. The emacs 24.5 feature having raw message buffer read-only is also now explicitly set to the buffer so the same experience is available with emaces < 24.5.
2015-09-02 16:34:39 +02:00
(inhibit-read-only t))
emacs: Use pop-to-buffer-same-window rather than switch-to-buffer This means that notmuch commands obey display-buffer-alist so the user can customize how buffers show up. It also permits the use of C-x 4 4, C-x 5 5 and C-x t t, available in Emacs 28. For example, one can use C-x 4 4 M-x notmuch-jump-search RET to open a saved search in another window rather than the current window. Or in notmuch-search mode, C-x 5 5 RET to view the message at point in a new frame. notmuch-tree has custom buffer display logic, so bind display-buffer-overriding-action to make pop-to-buffer-same-window behave exactly as switch-to-buffer while that function is running.
2020-08-11 18:59:13 +02:00
(pop-to-buffer-same-window buf)
emacs: notmuch-show-view-raw-message clears buffer, makes it read-only notmuch-show-view-raw-message() re-uses buffer created with same name (same Message-Id:) but it did not erase it before filling. If this ever happened, there were duplicated (potentially overlapping) content in the buffer. Now this is fixed. Apparently since emacs 24.5 the (view-buffer) makes the buffer read-only; so this problem would not have happened there, just that notmuch-show-view-raw-message() failed. This is fixed by setting inhibit-read-only t before erasing and filling the buffer. The emacs 24.5 feature having raw message buffer read-only is also now explicitly set to the buffer so the same experience is available with emaces < 24.5.
2015-09-02 16:34:39 +02:00
(erase-buffer)
(let ((coding-system-for-read 'no-conversion))
emacs: add duplicate support to notmuch-show-view-raw-message This fixes one of the bugs reported by Gregor in [1] [1]: id:87edxw8jp4.fsf@no.workgroup
2022-08-04 13:48:08 +02:00
(apply #'notmuch--call-process notmuch-command nil t nil "show" "--format=raw" args))
emacs: Use `view-mode' when examining raw messages. Explained-by: Carl Worth: This gives convenient keybindings for navigating the file and for quitting from the buffer, (since, with a raw message file the user will generally want to just view the message, not edit it).
2010-11-15 15:21:53 +01:00
(goto-char (point-min))
(set-buffer-modified-p nil)
emacs: notmuch-show-view-raw-message clears buffer, makes it read-only notmuch-show-view-raw-message() re-uses buffer created with same name (same Message-Id:) but it did not erase it before filling. If this ever happened, there were duplicated (potentially overlapping) content in the buffer. Now this is fixed. Apparently since emacs 24.5 the (view-buffer) makes the buffer read-only; so this problem would not have happened there, just that notmuch-show-view-raw-message() failed. This is fixed by setting inhibit-read-only t before erasing and filling the buffer. The emacs 24.5 feature having raw message buffer read-only is also now explicitly set to the buffer so the same experience is available with emaces < 24.5.
2015-09-02 16:34:39 +02:00
(setq buffer-read-only t)
emacs: Use `view-mode' when examining raw messages. Explained-by: Carl Worth: This gives convenient keybindings for navigating the file and for quitting from the buffer, (since, with a raw message file the user will generally want to just view the message, not edit it).
2010-11-15 15:21:53 +01:00
(view-buffer buf 'kill-buffer-if-not-modified)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: resume messages Provide functionality to resume editing a message previously saved with notmuch-draft-save, including decoding the X-Notmuch-Emacs-Secure header. Resume gets the raw file from notmuch and using the emacs function mime-to-mml reconstructs the message (including attachments). 'e' is bound to resume a draft from show or tree mode.
2016-11-13 15:08:50 +01:00
(defun notmuch-show-resume-message ()
"Resume EDITING the current draft message."
(interactive)
(notmuch-draft-resume (notmuch-show-get-message-id)))
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-pipe-message 'notmuch-doc
"Pipe the contents of the current message to a command.")
(put 'notmuch-show-pipe-message 'notmuch-prefix-doc
"Pipe the thread as an mbox to a command.")
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
(defun notmuch-show-pipe-message (entire-thread command)
emacs: Clean up a few documentation strings Correct some grammatical errors, fix some violations of standard documentation string formatting conventions, and be more precise.
2013-10-06 05:22:45 +02:00
"Pipe the contents of the current message (or thread) to COMMAND.
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Clean up a few documentation strings Correct some grammatical errors, fix some violations of standard documentation string formatting conventions, and be more precise.
2013-10-06 05:22:45 +02:00
COMMAND will be executed with the raw contents of the current
email message as stdin. Anything printed by the command to stdout
or stderr will appear in the *notmuch-pipe* buffer.
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
emacs: Clean up a few documentation strings Correct some grammatical errors, fix some violations of standard documentation string formatting conventions, and be more precise.
2013-10-06 05:22:45 +02:00
If ENTIRE-THREAD is non-nil (or when invoked with a prefix
argument), COMMAND will receive all open messages in the current
thread (formatted as an mbox) rather than only the current
message."
emacs: show: change emacs interactive pipe message. Previously the query string for piping a message to a command was "Pipe message to command: " regardless of whether the function was called with a prefix argument (which pipes all open messages to the command). This patch modifies the `interactive' command to reflect this.
2013-06-09 10:41:48 +02:00
(interactive (let ((query-string (if current-prefix-arg
"Pipe all open messages to command: "
"Pipe message to command: ")))
emacs/show: use read-shell-command instead of read-string This enables auto-completion of commands, something which plain read-string does not do. It's otherwise a drop-in replacement. According to `C-h f`, read-shell-command was introduced in Emacs 23.1 or earlier.
2022-08-30 16:17:45 +02:00
(list current-prefix-arg (read-shell-command query-string))))
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
(let (shell-command)
(if entire-thread
emacs: Avoid `mail-header-parse-address' in `notmuch-show-clean-address'. `mail-header-parse-address' expects un-decoded mailbox parts, which is not what we have at this point. Replace it with simple string deconstruction. Mark the corresponding test as no longer broken. Minor whitespace cleanup.
2012-01-25 14:53:58 +01:00
(setq shell-command
emacs: show: exclude bug fix The pipe message function (when used with a prefix) uses a search of the form "id:<id1> or id:<id2>" etc. Since the user says precisely which messages are wanted by opening them it should not use excludes.
2012-07-28 13:56:34 +02:00
(concat notmuch-command " show --format=mbox --exclude=false "
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
(shell-quote-argument
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(mapconcat 'identity
(notmuch-show-get-message-ids-for-open-messages)
" OR "))
emacs: Allow '|' to operate on multiple messages (by means of prefix argument). We extend the '|' command so that passing a prefix argument, (for example, "C-u |"), causes it to pipe all open messages in the current thread rather than just the single, current message.
2010-09-17 00:52:12 +02:00
" | " command))
(setq shell-command
emacs: Fix notmuch-show-pipe-message to use notmuch-command variable Previously notmuch command name was hardcoded into this function, which made remote use of pipe command impossible.
2010-11-07 00:09:18 +01:00
(concat notmuch-command " show --format=raw "
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(shell-quote-argument (notmuch-show-get-message-id))
" | " command)))
emacs: use the originating buffer's working directory for pipe Currently notmuch-show-pipe-message runs the command in the working directory of the *notmuch-pipe* buffer if it exists, and the current buffer's working directory (which is inherited to the new *notmuch-pipe* buffer) otherwise. This is all very surprising to the user, and it's difficult to know or change where the command will be run. Always use the current show buffer's working directory for piping. The user can check that with M-x pwd and change it with M-x cd. This is consistent with notmuch-show-pipe-part.
2014-03-01 14:17:50 +01:00
(let ((cwd default-directory)
(buf (get-buffer-create (concat "*notmuch-pipe*"))))
emacs: View the output of pipe command when it fails Previously, the user didn't know whether the pipe command succeeded or not. It was only possible to find it out by manually inspecting the work done (or not done) by the command or by manually switching to *notmuch-pipe* buffer and determine it from command output. For this the user had to first find the text corresponding to the last run of pipe command as the buffer accumulated the output from all pipe commands. This patch changes the following. The *notmuch-pipe* buffer is erased before every pipe command so it contains only the output from the last command. Additionally, when the command failed, the *notmuch-pipe* buffer is shown and an error message is displayed. with the output of pipe command.
2011-01-23 11:45:50 +01:00
(with-current-buffer buf
emacs: notmuch-show-pipe-message: cosmetics
2021-07-19 13:31:08 +02:00
(setq buffer-read-only t)
(let ((inhibit-read-only t))
(erase-buffer)
;; Use the originating buffer's working directory instead of
;; that of the pipe buffer.
(cd cwd)
emacs: fix call to nonexistent notmuch--call-process-shell-command Looks like a find/replace error in e722b4f4
2021-10-18 06:30:02 +02:00
(let ((exit-code (call-process-shell-command shell-command nil buf)))
emacs: notmuch-show-pipe-message: cosmetics
2021-07-19 13:31:08 +02:00
(goto-char (point-max))
(set-buffer-modified-p nil)
(unless (zerop exit-code)
(pop-to-buffer buf)
(message (format "Command '%s' exited abnormally with code %d"
shell-command exit-code)))))))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: make "+" and "-" tagging operations in notmuch-show more flexible Before the change, "+" and "-" tagging operations in notmuch-show view accepted only a single tag. The patch makes them use the recently added `notmuch-read-tag-changes' function, which allows to enter multiple tags with "+" and "-" prefixes. So after the change, "+" and "-" bindings in notmuch-show view allow to both add and remove multiple tags. The only difference between "+" and "-" is the minibuffer initial input ("+" and "-" respectively).
2012-02-05 08:13:45 +01:00
(defun notmuch-show-tag-message (&rest tag-changes)
"Change tags for the current message.
emacs: Avoid runtime use of `cl'. The GNU Emacs Lisp Reference Manual section D.1 says: > * Please don't require the cl package of Common Lisp extensions at > run time. Use of this package is optional, and it is not part of > the standard Emacs namespace. If your package loads cl at run time, > that could cause name clashes for users who don't use that package. > > However, there is no problem with using the cl package at compile > time, with (eval-when-compile (require 'cl)). That's sufficient for > using the macros in the cl package, because the compiler expands > them before generating the byte-code. Follow this advice, requiring the following changes where `cl' was used at runtime: - replace `rassoc-if' in `notmuch-search-buffer-title' with the `loop' macro and inline code. At the same time find the longest prefix which matches the query rather than simply the last, - replace `union', `intersection' and `set-difference' in `notmuch-show-add-tag' and `notmuch-show-remove-tag' with local code to calculate the result of adding and removing a list of tags from another list of tags.
2010-04-29 12:33:36 +02:00
emacs: make "+" and "-" tagging operations in notmuch-show more flexible Before the change, "+" and "-" tagging operations in notmuch-show view accepted only a single tag. The patch makes them use the recently added `notmuch-read-tag-changes' function, which allows to enter multiple tags with "+" and "-" prefixes. So after the change, "+" and "-" bindings in notmuch-show view allow to both add and remove multiple tags. The only difference between "+" and "-" is the minibuffer initial input ("+" and "-" respectively).
2012-02-05 08:13:45 +01:00
TAG-CHANGES is a list of tag operations for `notmuch-tag'."
emacs: Avoid runtime use of `cl'. The GNU Emacs Lisp Reference Manual section D.1 says: > * Please don't require the cl package of Common Lisp extensions at > run time. Use of this package is optional, and it is not part of > the standard Emacs namespace. If your package loads cl at run time, > that could cause name clashes for users who don't use that package. > > However, there is no problem with using the cl package at compile > time, with (eval-when-compile (require 'cl)). That's sufficient for > using the macros in the cl package, because the compiler expands > them before generating the byte-code. Follow this advice, requiring the following changes where `cl' was used at runtime: - replace `rassoc-if' in `notmuch-search-buffer-title' with the `loop' macro and inline code. At the same time find the longest prefix which matches the query rather than simply the last, - replace `union', `intersection' and `set-difference' in `notmuch-show-add-tag' and `notmuch-show-remove-tag' with local code to calculate the result of adding and removing a list of tags from another list of tags.
2010-04-29 12:33:36 +02:00
(let* ((current-tags (notmuch-show-get-tags))
emacs: make "+" and "-" tagging operations in notmuch-show more flexible Before the change, "+" and "-" tagging operations in notmuch-show view accepted only a single tag. The patch makes them use the recently added `notmuch-read-tag-changes' function, which allows to enter multiple tags with "+" and "-" prefixes. So after the change, "+" and "-" bindings in notmuch-show view allow to both add and remove multiple tags. The only difference between "+" and "-" is the minibuffer initial input ("+" and "-" respectively).
2012-02-05 08:13:45 +01:00
(new-tags (notmuch-update-tags current-tags tag-changes)))
emacs: Avoid runtime use of `cl'. The GNU Emacs Lisp Reference Manual section D.1 says: > * Please don't require the cl package of Common Lisp extensions at > run time. Use of this package is optional, and it is not part of > the standard Emacs namespace. If your package loads cl at run time, > that could cause name clashes for users who don't use that package. > > However, there is no problem with using the cl package at compile > time, with (eval-when-compile (require 'cl)). That's sufficient for > using the macros in the cl package, because the compiler expands > them before generating the byte-code. Follow this advice, requiring the following changes where `cl' was used at runtime: - replace `rassoc-if' in `notmuch-search-buffer-title' with the `loop' macro and inline code. At the same time find the longest prefix which matches the query rather than simply the last, - replace `union', `intersection' and `set-difference' in `notmuch-show-add-tag' and `notmuch-show-remove-tag' with local code to calculate the result of adding and removing a list of tags from another list of tags.
2010-04-29 12:33:36 +02:00
(unless (equal current-tags new-tags)
emacs: replace (funcall 'foo ...) with (foo ...) I can't see any benefit to the funcall, and it looks like the result of cut-and-paste from some code that actually used a variable for the function to call.
2013-06-02 14:16:10 +02:00
(notmuch-tag (notmuch-show-get-message-id) tag-changes)
emacs: Avoid runtime use of `cl'. The GNU Emacs Lisp Reference Manual section D.1 says: > * Please don't require the cl package of Common Lisp extensions at > run time. Use of this package is optional, and it is not part of > the standard Emacs namespace. If your package loads cl at run time, > that could cause name clashes for users who don't use that package. > > However, there is no problem with using the cl package at compile > time, with (eval-when-compile (require 'cl)). That's sufficient for > using the macros in the cl package, because the compiler expands > them before generating the byte-code. Follow this advice, requiring the following changes where `cl' was used at runtime: - replace `rassoc-if' in `notmuch-search-buffer-title' with the `loop' macro and inline code. At the same time find the longest prefix which matches the query rather than simply the last, - replace `union', `intersection' and `set-difference' in `notmuch-show-add-tag' and `notmuch-show-remove-tag' with local code to calculate the result of adding and removing a list of tags from another list of tags.
2010-04-29 12:33:36 +02:00
(notmuch-show-set-tags new-tags))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(defun notmuch-show-tag (tag-changes)
emacs: modify show tag functions to use new notmuch-tag interface The main change here is to modify argument parsing so as to not force tag-changes to be a list, and to let notmuch-tag handle prompting the user when required. doc strings are also updated and cleaned up.
2012-04-14 20:52:53 +02:00
"Change tags for the current message.
See `notmuch-tag' for information on the format of TAG-CHANGES."
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
"Tag message")))
(notmuch-tag (notmuch-show-get-message-id) tag-changes)
(let* ((current-tags (notmuch-show-get-tags))
emacs: modify show tag functions to use new notmuch-tag interface The main change here is to modify argument parsing so as to not force tag-changes to be a list, and to let notmuch-tag handle prompting the user when required. doc strings are also updated and cleaned up.
2012-04-14 20:52:53 +02:00
(new-tags (notmuch-update-tags current-tags tag-changes)))
(unless (equal current-tags new-tags)
(notmuch-show-set-tags new-tags))))
emacs: Avoid runtime use of `cl'. The GNU Emacs Lisp Reference Manual section D.1 says: > * Please don't require the cl package of Common Lisp extensions at > run time. Use of this package is optional, and it is not part of > the standard Emacs namespace. If your package loads cl at run time, > that could cause name clashes for users who don't use that package. > > However, there is no problem with using the cl package at compile > time, with (eval-when-compile (require 'cl)). That's sufficient for > using the macros in the cl package, because the compiler expands > them before generating the byte-code. Follow this advice, requiring the following changes where `cl' was used at runtime: - replace `rassoc-if' in `notmuch-search-buffer-title' with the `loop' macro and inline code. At the same time find the longest prefix which matches the query rather than simply the last, - replace `union', `intersection' and `set-difference' in `notmuch-show-add-tag' and `notmuch-show-remove-tag' with local code to calculate the result of adding and removing a list of tags from another list of tags.
2010-04-29 12:33:36 +02:00
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(defun notmuch-show-tag-all (tag-changes)
emacs: modify show tag functions to use new notmuch-tag interface The main change here is to modify argument parsing so as to not force tag-changes to be a list, and to let notmuch-tag handle prompting the user when required. doc strings are also updated and cleaned up.
2012-04-14 20:52:53 +02:00
"Change tags for all messages in the current show buffer.
emacs: add "*" binding for notmuch-show view The patch adds `notmuch-show-tag-all' function bound to "*" in notmuch-show view. The function is similar to the `notmuch-search-tag-all' function for the notmuch-search view: it changes tags for all messages in the current thread.
2012-02-05 08:13:48 +01:00
emacs: modify show tag functions to use new notmuch-tag interface The main change here is to modify argument parsing so as to not force tag-changes to be a list, and to let notmuch-tag handle prompting the user when required. doc strings are also updated and cleaned up.
2012-04-14 20:52:53 +02:00
See `notmuch-tag' for information on the format of TAG-CHANGES."
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(interactive
(list (let (tags)
(notmuch-show-mapc
(lambda () (setq tags (append (notmuch-show-get-tags) tags))))
(notmuch-read-tag-changes tags "Tag thread"))))
(notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
emacs: add "*" binding for notmuch-show view The patch adds `notmuch-show-tag-all' function bound to "*" in notmuch-show view. The function is similar to the `notmuch-search-tag-all' function for the notmuch-search view: it changes tags for all messages in the current thread.
2012-02-05 08:13:48 +01:00
(notmuch-show-mapc
(lambda ()
(let* ((current-tags (notmuch-show-get-tags))
(new-tags (notmuch-update-tags current-tags tag-changes)))
(unless (equal current-tags new-tags)
(notmuch-show-set-tags new-tags))))))
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(defun notmuch-show-add-tag (tag-changes)
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
"Change tags for the current message (defaulting to add).
Same as `notmuch-show-tag' but sets initial input to '+'."
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(interactive
(list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
(notmuch-show-tag tag-changes))
emacs: Avoid runtime use of `cl'. The GNU Emacs Lisp Reference Manual section D.1 says: > * Please don't require the cl package of Common Lisp extensions at > run time. Use of this package is optional, and it is not part of > the standard Emacs namespace. If your package loads cl at run time, > that could cause name clashes for users who don't use that package. > > However, there is no problem with using the cl package at compile > time, with (eval-when-compile (require 'cl)). That's sufficient for > using the macros in the cl package, because the compiler expands > them before generating the byte-code. Follow this advice, requiring the following changes where `cl' was used at runtime: - replace `rassoc-if' in `notmuch-search-buffer-title' with the `loop' macro and inline code. At the same time find the longest prefix which matches the query rather than simply the last, - replace `union', `intersection' and `set-difference' in `notmuch-show-add-tag' and `notmuch-show-remove-tag' with local code to calculate the result of adding and removing a list of tags from another list of tags.
2010-04-29 12:33:36 +02:00
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(defun notmuch-show-remove-tag (tag-changes)
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
"Change tags for the current message (defaulting to remove).
Same as `notmuch-show-tag' but sets initial input to '-'."
emacs: Use interactive specifications for tag changes in show This modifies all tagging operations in show to call `notmuch-read-tag-changes' in their interactive specification to input tag changes, rather than depending on lower-level functions to prompt for tag changes regardless of their calling context. Besides being more Elispy and providing a more consistent programmatic API, this enables callers to provide two call site-specific pieces of information: an appropriate prompt, and the set of visible tags. The prompt lets us differentiate * from +/-. Providing visible tags enables a more consistent user experience than retrieving the (potentially different) tags from the database, and avoids a round-trip to the CLI and database.
2013-10-23 02:21:56 +02:00
(interactive
(list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
(notmuch-show-tag tag-changes))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: rename `notmuch-show-toggle-headers' to `notmuch-show-toggle-visibility-headers' * emacs/notmuch-show.el (notmuch-show-toggle-headers): Rename to `notmuch-show-toggle-visibility-headers'. (notmuch-show-mode-map): Update "h" binding wrt renamed `notmuch-show-toggle-headers'. (notmuch-message-headers): Update docstring wrt renamed `notmuch-show-toggle-headers'. (notmuch-message-headers-visible): Update docstring wrt renamed `notmuch-show-toggle-headers'. Also fixed a small typo. * test/emacs: Update subtest wrt renamed `notmuch-show-toggle-headers': - "notmuch-show: hide message headers (w/ notmuch-show-toggle-headers)"
2012-02-22 19:43:30 +01:00
(defun notmuch-show-toggle-visibility-headers ()
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
"Toggle the visibility of the current message headers."
(interactive)
(let ((props (notmuch-show-get-message-properties)))
(notmuch-show-headers-visible
props
(not (plist-get props :headers-visible))))
(force-window-update))
(defun notmuch-show-toggle-message ()
"Toggle the visibility of the current message."
(interactive)
(let ((props (notmuch-show-get-message-properties)))
(notmuch-show-message-visible
props
(not (plist-get props :message-visible))))
(force-window-update))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
(put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
emacs: Rename notmuch-show-toggle-all to notmuch-show-open-or-close-all The function was named and documented incorrectly before, saying that it would "change the visibility of all messages". Instead it only opens the messages that are closed---it doesn't simultanesously close the messages that are open. (Granted, nobody would *want* that behavior I don't think, but the naming was confusing before.)
2010-04-24 02:27:14 +02:00
(defun notmuch-show-open-or-close-all ()
"Set the visibility all of the messages in the current thread.
emacs: Clean up a few documentation strings Correct some grammatical errors, fix some violations of standard documentation string formatting conventions, and be more precise.
2013-10-06 05:22:45 +02:00
emacs: Rename notmuch-show-toggle-all to notmuch-show-open-or-close-all The function was named and documented incorrectly before, saying that it would "change the visibility of all messages". Instead it only opens the messages that are closed---it doesn't simultanesously close the messages that are open. (Granted, nobody would *want* that behavior I don't think, but the naming was confusing before.)
2010-04-24 02:27:14 +02:00
By default make all of the messages visible. With a prefix
argument, hide all of the messages."
emacs/notmuch-show.el: Add `notmuch-show-toggle-all' bound to M-RET `notmuch-show-toggle-all' changes the visibility all of the messages in the current thread. By default it makes all of the messages visible. With a prefix argument, it makes them all not visible.
2010-04-22 10:24:03 +02:00
(interactive)
(save-excursion
(goto-char (point-min))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(cl-loop do (notmuch-show-message-visible
(notmuch-show-get-message-properties)
(not current-prefix-arg))
emacs: Use `cl-lib' instead of deprecated `cl' Starting with Emacs 27 the old `cl' implementation is finally considered obsolete. Previously its use was strongly discouraged at run-time but one was still allowed to use it at compile-time. For the most part the transition is very simple and boils down to adding the "cl-" prefix to some symbols. A few replacements do not follow that simple pattern; e.g. `first' is replaced with `car', even though the alias `cl-first' exists, because the latter is not idiomatic emacs-lisp. In a few cases we start using `pcase-let' or `pcase-lambda' instead of renaming e.g. `first' to `car'. That way we can remind the reader of the meaning of the various parts of the data that is being deconstructed. An obsolete `lexical-let' and a `lexical-let*' are replaced with their regular variants `let' and `let*' even though we do not at the same time enable `lexical-binding' for that file. That is the right thing to do because it does not actually make a difference in those cases whether lexical bindings are used or not, and because this should be enabled in a separate commit. We need to explicitly depend on the `cl-lib' package because Emacs 24.1 and 24.2 lack that library. When using these releases we end up using the backport from GNU Elpa. We need to explicitly require the `pcase' library because `pcase-dolist' was not autoloaded until Emacs 25.1.
2020-04-25 22:18:07 +02:00
until (not (notmuch-show-goto-message-next))))
emacs/notmuch-show.el: Add `notmuch-show-toggle-all' bound to M-RET `notmuch-show-toggle-all' changes the visibility all of the messages in the current thread. By default it makes all of the messages visible. With a prefix argument, it makes them all not visible.
2010-04-22 10:24:03 +02:00
(force-window-update))
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-next-button ()
"Advance point to the next button in the buffer."
(interactive)
(forward-button 1))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-previous-button ()
"Move point back to the previous button in the buffer."
(interactive)
(backward-button 1))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: add show view bindings to move to previous/next thread We have most of the plumbing in place, add the bindings M-n and M-p.
2013-05-25 23:13:30 +02:00
(defun notmuch-show-next-thread (&optional show previous)
"Move to the next item in the search results, if any.
If SHOW is non-nil, open the next item in a show
buffer. Otherwise just highlight the next item in the search
buffer. If PREVIOUS is non-nil, move to the previous item in the
emacs: Make notmuch-show-next-thread return nil on failure Having notmuch-show-next-thread return non-nil on success and nil on failure makes it easier for users to interact with notmuch via elisp. This commit changes notmuch-search-show-thread too since the return value of notmuch-show-next-thread depends on notmuch-search-show-thread. Amended by db: fix whitespace in T450-emacs-show
2022-06-09 17:18:22 +02:00
search results instead.
Return non-nil on success."
emacs: break up notmuch-show-archive-thread-internal into two more generally useful functions Break up notmuch-show-archive-thread-internal into two new functions: notmuch-show-tag-thread-internal: applies a tag to all messages in thread. If option remove flag is t, tags will be removed instead of added. notmuch-show-next-thread: moves to the next thread in the search result. If given a prefix, will show the next result, otherwise will just move to it in the search view. Two new interactive functions, notmuch-show-{add,remove}-tag-thread, are also added. Together, these provide a better suit of thread tagging and navigation tools. The higher level thread archiving functions are modified to use these new function.
2012-01-25 01:06:17 +01:00
(interactive "P")
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(let ((parent-buffer notmuch-show-parent-buffer))
emacs: Improve the behaviour of the 'q' binding. When a user hits 'q' in a notmuch buffer, kill the buffer only if there are no other windows currently showing it.
2014-10-29 15:18:49 +01:00
(notmuch-bury-or-kill-this-buffer)
emacs: Check that the parent buffer is alive before using it.
2012-02-08 09:02:17 +01:00
(when (buffer-live-p parent-buffer)
emacs: break up notmuch-show-archive-thread-internal into two more generally useful functions Break up notmuch-show-archive-thread-internal into two new functions: notmuch-show-tag-thread-internal: applies a tag to all messages in thread. If option remove flag is t, tags will be removed instead of added. notmuch-show-next-thread: moves to the next thread in the search result. If given a prefix, will show the next result, otherwise will just move to it in the search view. Two new interactive functions, notmuch-show-{add,remove}-tag-thread, are also added. Together, these provide a better suit of thread tagging and navigation tools. The higher level thread archiving functions are modified to use these new function.
2012-01-25 01:06:17 +01:00
(switch-to-buffer parent-buffer)
emacs: add show view bindings to move to previous/next thread We have most of the plumbing in place, add the bindings M-n and M-p.
2013-05-25 23:13:30 +02:00
(and (if previous
(notmuch-search-previous-thread)
(notmuch-search-next-thread))
show
(notmuch-search-show-thread)))))
(defun notmuch-show-next-thread-show ()
"Show the next thread in the search results, if any."
(interactive)
(notmuch-show-next-thread t))
(defun notmuch-show-previous-thread-show ()
"Show the previous thread in the search results, if any."
(interactive)
(notmuch-show-next-thread t t))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-archive-thread 'notmuch-prefix-doc
"Un-archive each message in thread.")
emacs: break out thread navigation from notmuch-show-archive-thread This function is now just for archiving the current thread. A new function is created to archive-then-next. The 'a' key binding is updated accordingly. This will allow people to bind to the simple thread archiving function without the extra navigation. The archive-thread function now also takes a prefix to unarchive the current thread (ie. put the whole thread back in the inbox).
2012-01-25 01:06:18 +01:00
(defun notmuch-show-archive-thread (&optional unarchive)
"Archive each message in thread.
emacs: add support for custom tag changes on message/thread archive Add support for customization of the tag changes that are applied when a message or a thread is archived. Instead of hard-coded removal of the "inbox" tag, the user can now specify a list of tag changes to perform.
2012-09-06 17:32:40 +02:00
Archive each message currently shown by applying the tag changes
emacs: remove hardcoded defaults values from docstrings These functions refer to default values of variables, but it seems less confusing and less likely to get out of date to just allow the user to follow the help cross-reference links.
2013-06-02 16:04:45 +02:00
in `notmuch-archive-tags' to each. If a prefix argument is given,
the messages will be \"unarchived\", i.e. the tag changes in
`notmuch-archive-tags' will be reversed.
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
Note: This command is safe from any race condition of new messages
being delivered to the same thread. It does not archive the
entire thread, but only the messages shown in the current
buffer."
emacs: break out thread navigation from notmuch-show-archive-thread This function is now just for archiving the current thread. A new function is created to archive-then-next. The 'a' key binding is updated accordingly. This will allow people to bind to the simple thread archiving function without the extra navigation. The archive-thread function now also takes a prefix to unarchive the current thread (ie. put the whole thread back in the inbox).
2012-01-25 01:06:18 +01:00
(interactive "P")
emacs: add support for custom tag changes on message/thread archive Add support for customization of the tag changes that are applied when a message or a thread is archived. Instead of hard-coded removal of the "inbox" tag, the user can now specify a list of tag changes to perform.
2012-09-06 17:32:40 +02:00
(when notmuch-archive-tags
(notmuch-show-tag-all
(notmuch-tag-change-list notmuch-archive-tags unarchive))))
emacs: break out thread navigation from notmuch-show-archive-thread This function is now just for archiving the current thread. A new function is created to archive-then-next. The 'a' key binding is updated accordingly. This will allow people to bind to the simple thread archiving function without the extra navigation. The archive-thread function now also takes a prefix to unarchive the current thread (ie. put the whole thread back in the inbox).
2012-01-25 01:06:18 +01:00
(defun notmuch-show-archive-thread-then-next ()
emacs: Clarify description of thread manipulating functions It is not clear whether the term "thread" refers to the thread in the database or to the thread currently shown in a buffer. Those two meanings may refer to different sets of messages, e.g. when a new email is added to the database while the buffer shows the state before the new email arrived. This patch replaces the term thread with the term current buffer, which is hopefully less ambiguous.
2012-02-21 10:15:08 +01:00
"Archive all messages in the current buffer, then show next thread from search."
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(interactive)
emacs: break out thread navigation from notmuch-show-archive-thread This function is now just for archiving the current thread. A new function is created to archive-then-next. The 'a' key binding is updated accordingly. This will allow people to bind to the simple thread archiving function without the extra navigation. The archive-thread function now also takes a prefix to unarchive the current thread (ie. put the whole thread back in the inbox).
2012-01-25 01:06:18 +01:00
(notmuch-show-archive-thread)
emacs: break up notmuch-show-archive-thread-internal into two more generally useful functions Break up notmuch-show-archive-thread-internal into two new functions: notmuch-show-tag-thread-internal: applies a tag to all messages in thread. If option remove flag is t, tags will be removed instead of added. notmuch-show-next-thread: moves to the next thread in the search result. If given a prefix, will show the next result, otherwise will just move to it in the search view. Two new interactive functions, notmuch-show-{add,remove}-tag-thread, are also added. Together, these provide a better suit of thread tagging and navigation tools. The higher level thread archiving functions are modified to use these new function.
2012-01-25 01:06:17 +01:00
(notmuch-show-next-thread t))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(defun notmuch-show-archive-thread-then-exit ()
emacs: Clarify description of thread manipulating functions It is not clear whether the term "thread" refers to the thread in the database or to the thread currently shown in a buffer. Those two meanings may refer to different sets of messages, e.g. when a new email is added to the database while the buffer shows the state before the new email arrived. This patch replaces the term thread with the term current buffer, which is hopefully less ambiguous.
2012-02-21 10:15:08 +01:00
"Archive all messages in the current buffer, then exit back to search results."
emacs: JSON based implementation Re-implement notmuch-show.el using the JSON output format of the notmuch command. Most functionality is retained - HTML display is noticeably missing.
2010-04-11 09:58:43 +02:00
(interactive)
emacs: break out thread navigation from notmuch-show-archive-thread This function is now just for archiving the current thread. A new function is created to archive-then-next. The 'a' key binding is updated accordingly. This will allow people to bind to the simple thread archiving function without the extra navigation. The archive-thread function now also takes a prefix to unarchive the current thread (ie. put the whole thread back in the inbox).
2012-01-25 01:06:18 +01:00
(notmuch-show-archive-thread)
emacs: break up notmuch-show-archive-thread-internal into two more generally useful functions Break up notmuch-show-archive-thread-internal into two new functions: notmuch-show-tag-thread-internal: applies a tag to all messages in thread. If option remove flag is t, tags will be removed instead of added. notmuch-show-next-thread: moves to the next thread in the search result. If given a prefix, will show the next result, otherwise will just move to it in the search view. Two new interactive functions, notmuch-show-{add,remove}-tag-thread, are also added. Together, these provide a better suit of thread tagging and navigation tools. The higher level thread archiving functions are modified to use these new function.
2012-01-25 01:06:17 +01:00
(notmuch-show-next-thread))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-archive-message 'notmuch-prefix-doc
"Un-archive the current message.")
emacs: add message archiving functions This adds two new message archiving functions that parallel the thread archiving functions: notmuch-show-archive-message{,-then-next}. The former also takes a prefix argument to unarchive the message (ie. put back in inbox).
2012-01-25 01:06:19 +01:00
(defun notmuch-show-archive-message (&optional unarchive)
emacs: add support for custom tag changes on message/thread archive Add support for customization of the tag changes that are applied when a message or a thread is archived. Instead of hard-coded removal of the "inbox" tag, the user can now specify a list of tag changes to perform.
2012-09-06 17:32:40 +02:00
"Archive the current message.
emacs: add message archiving functions This adds two new message archiving functions that parallel the thread archiving functions: notmuch-show-archive-message{,-then-next}. The former also takes a prefix argument to unarchive the message (ie. put back in inbox).
2012-01-25 01:06:19 +01:00
emacs: add support for custom tag changes on message/thread archive Add support for customization of the tag changes that are applied when a message or a thread is archived. Instead of hard-coded removal of the "inbox" tag, the user can now specify a list of tag changes to perform.
2012-09-06 17:32:40 +02:00
Archive the current message by applying the tag changes in
emacs: remove hardcoded defaults values from docstrings These functions refer to default values of variables, but it seems less confusing and less likely to get out of date to just allow the user to follow the help cross-reference links.
2013-06-02 16:04:45 +02:00
`notmuch-archive-tags' to it. If a prefix argument is given, the
message will be \"unarchived\", i.e. the tag changes in
`notmuch-archive-tags' will be reversed."
emacs: add message archiving functions This adds two new message archiving functions that parallel the thread archiving functions: notmuch-show-archive-message{,-then-next}. The former also takes a prefix argument to unarchive the message (ie. put back in inbox).
2012-01-25 01:06:19 +01:00
(interactive "P")
emacs: add support for custom tag changes on message/thread archive Add support for customization of the tag changes that are applied when a message or a thread is archived. Instead of hard-coded removal of the "inbox" tag, the user can now specify a list of tag changes to perform.
2012-09-06 17:32:40 +02:00
(when notmuch-archive-tags
(apply 'notmuch-show-tag-message
(notmuch-tag-change-list notmuch-archive-tags unarchive))))
emacs: add message archiving functions This adds two new message archiving functions that parallel the thread archiving functions: notmuch-show-archive-message{,-then-next}. The former also takes a prefix argument to unarchive the message (ie. put back in inbox).
2012-01-25 01:06:19 +01:00
emacs: make show view a/A/x/X key bindings more consistent Modify the show view key bindings as follows to make them more consistent: 'a' = Archive current message, then move to next message, or show next thread from search if at the last message in thread. 'A' = Archive each message in thread, then show next thread from search. 'x' = Archive current message, then move to next message, or exit back to search results if at the last message in thread. 'X' = Archive each message in thread, then exit back to search results. The changes make the key bindings more consistent in two ways: 1) 'a'/'A' both advance to the next thread like 'a' used to. 2) 'x' operates on messages and 'X' on threads like 'a'/'A'.
2012-01-31 18:29:06 +01:00
(defun notmuch-show-archive-message-then-next-or-exit ()
emacs: Make first documentation line distinct for "a" and "x" commands. Since only the first line of the documentation is shown by the help command, it is confusing when "x" and "a" seem to have the same binding in show-mode. This commit makes the two function documentations first lines different and (hopefully) clearer.
2019-04-05 17:35:50 +02:00
"Archive current message, then show next open message in current thread.
emacs: make show view a/A/x/X key bindings more consistent Modify the show view key bindings as follows to make them more consistent: 'a' = Archive current message, then move to next message, or show next thread from search if at the last message in thread. 'A' = Archive each message in thread, then show next thread from search. 'x' = Archive current message, then move to next message, or exit back to search results if at the last message in thread. 'X' = Archive each message in thread, then exit back to search results. The changes make the key bindings more consistent in two ways: 1) 'a'/'A' both advance to the next thread like 'a' used to. 2) 'x' operates on messages and 'X' on threads like 'a'/'A'.
2012-01-31 18:29:06 +01:00
If at the last open message in the current thread, then exit back
to search results."
emacs: add message archiving functions This adds two new message archiving functions that parallel the thread archiving functions: notmuch-show-archive-message{,-then-next}. The former also takes a prefix argument to unarchive the message (ie. put back in inbox).
2012-01-25 01:06:19 +01:00
(interactive)
(notmuch-show-archive-message)
emacs: use pop-at-end functionality in show-archive-message-then-next function This provides a smoother message processing flow by reducing the number of key presses needed for these common operations.
2012-01-25 01:06:21 +01:00
(notmuch-show-next-open-message t))
emacs: add message archiving functions This adds two new message archiving functions that parallel the thread archiving functions: notmuch-show-archive-message{,-then-next}. The former also takes a prefix argument to unarchive the message (ie. put back in inbox).
2012-01-25 01:06:19 +01:00
emacs: make show view a/A/x/X key bindings more consistent Modify the show view key bindings as follows to make them more consistent: 'a' = Archive current message, then move to next message, or show next thread from search if at the last message in thread. 'A' = Archive each message in thread, then show next thread from search. 'x' = Archive current message, then move to next message, or exit back to search results if at the last message in thread. 'X' = Archive each message in thread, then exit back to search results. The changes make the key bindings more consistent in two ways: 1) 'a'/'A' both advance to the next thread like 'a' used to. 2) 'x' operates on messages and 'X' on threads like 'a'/'A'.
2012-01-31 18:29:06 +01:00
(defun notmuch-show-archive-message-then-next-or-next-thread ()
emacs: Make first documentation line distinct for "a" and "x" commands. Since only the first line of the documentation is shown by the help command, it is confusing when "x" and "a" seem to have the same binding in show-mode. This commit makes the two function documentations first lines different and (hopefully) clearer.
2019-04-05 17:35:50 +02:00
"Archive current message, then show next open message in current or next thread.
emacs: make show view a/A/x/X key bindings more consistent Modify the show view key bindings as follows to make them more consistent: 'a' = Archive current message, then move to next message, or show next thread from search if at the last message in thread. 'A' = Archive each message in thread, then show next thread from search. 'x' = Archive current message, then move to next message, or exit back to search results if at the last message in thread. 'X' = Archive each message in thread, then exit back to search results. The changes make the key bindings more consistent in two ways: 1) 'a'/'A' both advance to the next thread like 'a' used to. 2) 'x' operates on messages and 'X' on threads like 'a'/'A'.
2012-01-31 18:29:06 +01:00
If at the last open message in the current thread, then show next
thread from search."
(interactive)
(notmuch-show-archive-message)
(unless (notmuch-show-next-open-message)
(notmuch-show-next-thread t)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-stash-cc ()
"Copy CC field of current message to kill-ring."
(interactive)
emacs: mv notmuch-{show,common}-do-stash Here we move the notmuch-show/notmuch-show-do-stash function to notmuch-lib/notmuch-common-do-stash. Nothing in this function is notmuch-show mode specific, so this move will make it cleaner to be used by other modes (such as notmuch-search).
2010-09-18 21:48:21 +02:00
(notmuch-common-do-stash (notmuch-show-get-cc)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: with prefix argument, notmuch-show-stash-date stashes timestamp Using timestamp of a message is useful in many Xapian queries.
2017-04-08 20:33:43 +02:00
(put 'notmuch-show-stash-date 'notmuch-prefix-doc
"Copy timestamp of current message to kill-ring.")
(defun notmuch-show-stash-date (&optional stash-timestamp)
"Copy date of current message to kill-ring.
If invoked with a prefix argument, copy timestamp of current
message to kill-ring."
(interactive "P")
(if stash-timestamp
(notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
(notmuch-common-do-stash (notmuch-show-get-date))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-stash-filename ()
"Copy filename of current message to kill-ring."
(interactive)
emacs: mv notmuch-{show,common}-do-stash Here we move the notmuch-show/notmuch-show-do-stash function to notmuch-lib/notmuch-common-do-stash. Nothing in this function is notmuch-show mode specific, so this move will make it cleaner to be used by other modes (such as notmuch-search).
2010-09-18 21:48:21 +02:00
(notmuch-common-do-stash (notmuch-show-get-filename)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-stash-from ()
"Copy From address of current message to kill-ring."
(interactive)
emacs: mv notmuch-{show,common}-do-stash Here we move the notmuch-show/notmuch-show-do-stash function to notmuch-lib/notmuch-common-do-stash. Nothing in this function is notmuch-show mode specific, so this move will make it cleaner to be used by other modes (such as notmuch-search).
2010-09-18 21:48:21 +02:00
(notmuch-common-do-stash (notmuch-show-get-from)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: Improve interactive use documentation This improves the function documentation for many interactive commands, either by improving their documentation string where the improvement also makes sense for programmatic use or by adding a 'notmuch-doc property where it doesn't. For nearly all commands that support a prefix argument, this adds a 'notmuch-prefix-doc property to document their prefixed behavior This omits prefix documentation for a few commands where I thought the prefixed behavior was too obscure (or too complex to fit in one line).
2013-10-06 05:22:47 +02:00
(put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
"Copy thread: query matching current thread to kill-ring.")
emacs: add support for stashing the thread id in show view Add a prefix argument to notmuch-show-stash-message-id to stash thread id instead of message id.
2012-12-06 23:48:05 +01:00
(defun notmuch-show-stash-message-id (&optional stash-thread-id)
"Copy id: query matching the current message to kill-ring.
If invoked with a prefix argument (or STASH-THREAD-ID is
non-nil), copy thread: query matching the current thread to
kill-ring."
(interactive "P")
(if stash-thread-id
(notmuch-common-do-stash notmuch-show-thread-id)
(notmuch-common-do-stash (notmuch-show-get-message-id))))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: add keybind and function to stash Message-ID without prefix Add function `notmuch-show-stash-message-id-stripped' which stashes a Message-ID after ripping off the prefix and quotes, add bind it to "I" key in `notmuch-show-stash-map'. Simplifying `notmuch-show-get-message-id' instead might seem better, but that would require concat'ing in 9 places instead of 1. Signed-off-by: Pieter Praet <pieter@praet.org>
2011-06-30 10:20:50 +02:00
(defun notmuch-show-stash-message-id-stripped ()
"Copy message ID of current message (sans `id:' prefix) to kill-ring."
(interactive)
emacs: `notmuch-show-get-message-id': optionally return Message-Id sans prefix * emacs/notmuch-show.el (notmuch-show-get-message-id): Add optional arg BARE. When non-nil, return a Message-Id without quotes and prefix, thus obviating the need to strip them off again in various places. (notmuch-show-stash-message-id-stripped): Update wrt changes in `notmuch-show-get-message-id'.
2012-02-19 21:50:25 +01:00
(notmuch-common-do-stash (notmuch-show-get-message-id t)))
emacs: add keybind and function to stash Message-ID without prefix Add function `notmuch-show-stash-message-id-stripped' which stashes a Message-ID after ripping off the prefix and quotes, add bind it to "I" key in `notmuch-show-stash-map'. Simplifying `notmuch-show-get-message-id' instead might seem better, but that would require concat'ing in 9 places instead of 1. Signed-off-by: Pieter Praet <pieter@praet.org>
2011-06-30 10:20:50 +02:00
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-stash-subject ()
"Copy Subject field of current message to kill-ring."
(interactive)
emacs: mv notmuch-{show,common}-do-stash Here we move the notmuch-show/notmuch-show-do-stash function to notmuch-lib/notmuch-common-do-stash. Nothing in this function is notmuch-show mode specific, so this move will make it cleaner to be used by other modes (such as notmuch-search).
2010-09-18 21:48:21 +02:00
(notmuch-common-do-stash (notmuch-show-get-subject)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-stash-tags ()
"Copy tags of current message to kill-ring as a comma separated list."
(interactive)
emacs: mv notmuch-{show,common}-do-stash Here we move the notmuch-show/notmuch-show-do-stash function to notmuch-lib/notmuch-common-do-stash. Nothing in this function is notmuch-show mode specific, so this move will make it cleaner to be used by other modes (such as notmuch-search).
2010-09-18 21:48:21 +02:00
(notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(defun notmuch-show-stash-to ()
"Copy To address of current message to kill-ring."
(interactive)
emacs: mv notmuch-{show,common}-do-stash Here we move the notmuch-show/notmuch-show-do-stash function to notmuch-lib/notmuch-common-do-stash. Nothing in this function is notmuch-show mode specific, so this move will make it cleaner to be used by other modes (such as notmuch-search).
2010-09-18 21:48:21 +02:00
(notmuch-common-do-stash (notmuch-show-get-to)))
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
(defun notmuch-show-stash-mlarchive-link (&optional mla)
"Copy an ML Archive URI for the current message to the kill-ring.
This presumes that the message is available at the selected Mailing List Archive.
If optional argument MLA is non-nil, use the provided key instead of prompting
the user (see `notmuch-show-stash-mlarchive-link-alist')."
(interactive)
emacs: allow functions in notmuch-show-stash-mlarchive-link-alist Some archives may use a more complicated scheme for referring to messages than just concatenated url and message-id. In particular, patchwork requires a query to translate message-id to a patchwork patch id. Allow functions in notmuch-show-stash-mlarchive-link-alist to facilitate this. For example, one could use something like this for patchwork. (lambda (message-id) (concat "http://patchwork.example.com/patch/" (nth 0 (split-string (car (last (process-lines "pwclient" "search" "-n" "1" "-m" (concat "<" message-id ">"))))))))
2014-05-01 14:35:11 +02:00
(let ((url (cdr (assoc
(or mla
(let ((completion-ignore-case t))
(completing-read
"Mailing List Archive: "
notmuch-show-stash-mlarchive-link-alist
nil t nil nil
notmuch-show-stash-mlarchive-link-default)))
notmuch-show-stash-mlarchive-link-alist))))
(notmuch-common-do-stash
(if (functionp url)
(funcall url (notmuch-show-get-message-id t))
(concat url (notmuch-show-get-message-id t))))))
emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}' * emacs/notmuch-show.el (notmuch-show-stash-mlarchive-link-alist): New defcustom of type `alist' (key = name, value = URI), containing Mailing List Archive URI's for searching by Message-Id. (notmuch-show-stash-mlarchive-link-default): New defcustom, default MLA to use when `notmuch-show-stash-mlarchive-link' received no user input whatsoever. Available choices are generated using the contents of `notmuch-show-stash-mlarchive-link-alist'. (notmuch-show-stash-map): Added keybinds "l" and "L" for `notmuch-show-stash-mlarchive-link' respectively `notmuch-show-stash-mlarchive-link-and-go'. (notmuch-show-stash-mlarchive-link): New function, stashes a URI pointing to the current message at one of the MLAs configured in `notmuch-show-stash-mlarchive-link-alist'. Prompts user with `completing-read' if not provided with an MLA key. (notmuch-show-stash-mlarchive-link-and-go): New function, uses `notmuch-show-stash-mlarchive-link' to stash a URI, and then visits it using the browser configured in `browse-url-browser-function'. Based on original work [1] by David Edmondson <dme@dme.org>. [1] id:"1327397873-20596-1-git-send-email-dme@dme.org"
2012-02-19 21:50:27 +01:00
(defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
"Copy an ML Archive URI for the current message to the kill-ring and visit it.
This presumes that the message is available at the selected Mailing List Archive.
If optional argument MLA is non-nil, use the provided key instead of prompting
the user (see `notmuch-show-stash-mlarchive-link-alist')."
(interactive)
(notmuch-show-stash-mlarchive-link mla)
(browse-url (current-kill 0 t)))
emacs: add stash support for git send-email command line Stash From/To/Cc as --to/--to/--cc, respectively, and Message-Id as --in-reply-to, suitable for pasting to git send-email command line.
2015-01-02 18:48:17 +01:00
(defun notmuch-show-stash-git-helper (addresses prefix)
emacs: shorten/replace first sentence of a few doc-strings The first sentence should fit on the first line. It is okay if the first sentence/line does not contain all the information that the rest of the doc-string covers.
2020-11-16 22:28:27 +01:00
"Normalize all ADDRESSES while adding PREFIX.
Escape, trim, quote and add PREFIX to each address in list
of ADDRESSES, and return the result as a single string."
emacs: add stash support for git send-email command line Stash From/To/Cc as --to/--to/--cc, respectively, and Message-Id as --in-reply-to, suitable for pasting to git send-email command line.
2015-01-02 18:48:17 +01:00
(mapconcat (lambda (x)
(concat prefix "\""
;; escape double-quotes
(replace-regexp-in-string
"\"" "\\\\\""
;; trim leading and trailing spaces
(replace-regexp-in-string
"\\(^ *\\| *$\\)" ""
x)) "\""))
addresses " "))
(put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
emacs: shorten/replace first sentence of a few doc-strings The first sentence should fit on the first line. It is okay if the first sentence/line does not contain all the information that the rest of the doc-string covers.
2020-11-16 22:28:27 +01:00
"Copy From/To/Cc of current message to kill-ring.
Use a form suitable for pasting to git send-email command line.")
emacs: add stash support for git send-email command line Stash From/To/Cc as --to/--to/--cc, respectively, and Message-Id as --in-reply-to, suitable for pasting to git send-email command line.
2015-01-02 18:48:17 +01:00
(defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
emacs: shorten/replace first sentence of a few doc-strings The first sentence should fit on the first line. It is okay if the first sentence/line does not contain all the information that the rest of the doc-string covers.
2020-11-16 22:28:27 +01:00
"Copy From/To/Cc/Message-Id of current message to kill-ring.
Use a form suitable for pasting to git send-email command line.
emacs: add stash support for git send-email command line Stash From/To/Cc as --to/--to/--cc, respectively, and Message-Id as --in-reply-to, suitable for pasting to git send-email command line.
2015-01-02 18:48:17 +01:00
If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
omit --in-reply-to=<Message-Id>."
(interactive "P")
(notmuch-common-do-stash
(mapconcat 'identity
(remove ""
(list
(notmuch-show-stash-git-helper
(message-tokenize-header (notmuch-show-get-from)) "--to=")
(notmuch-show-stash-git-helper
(message-tokenize-header (notmuch-show-get-to)) "--to=")
(notmuch-show-stash-git-helper
(message-tokenize-header (notmuch-show-get-cc)) "--cc=")
(unless no-in-reply-to
(notmuch-show-stash-git-helper
(list (notmuch-show-get-message-id t)) "--in-reply-to="))))
" ")))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; Interactive part functions and their helpers
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
emacs: Create an API for fetching parts as undecoded binary The new function, `notmuch-get-bodypart-binary', replaces `notmuch-get-bodypart-internal'. Whereas the old function was really meant for internal use in `notmuch-get-bodypart-content', it was used in a few other places. Since the difference between `notmuch-get-bodypart-content' and `notmuch-get-bodypart-internal' was unclear, these other uses were always confusing and potentially inconsistent. The new call clearly requests the part as undecoded binary. This is step 1 of 2 in separating `notmuch-get-bodypart-content' into two APIs for retrieving either undecoded binary or decoded text.
2015-01-24 22:16:57 +01:00
(defun notmuch-show-generate-part-buffer (msg part)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
"Return a temporary buffer containing the specified part's content."
(let ((buf (generate-new-buffer " *notmuch-part*"))
(process-crypto notmuch-show-process-crypto))
(with-current-buffer buf
emacs: Create an API for fetching parts as undecoded binary The new function, `notmuch-get-bodypart-binary', replaces `notmuch-get-bodypart-internal'. Whereas the old function was really meant for internal use in `notmuch-get-bodypart-content', it was used in a few other places. Since the difference between `notmuch-get-bodypart-content' and `notmuch-get-bodypart-internal' was unclear, these other uses were always confusing and potentially inconsistent. The new call clearly requests the part as undecoded binary. This is step 1 of 2 in separating `notmuch-get-bodypart-content' into two APIs for retrieving either undecoded binary or decoded text.
2015-01-24 22:16:57 +01:00
;; This is always used in the content of mm handles, which
;; expect undecoded, binary part content.
(insert (notmuch-get-bodypart-binary msg part process-crypto)))
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
buf))
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(defun notmuch-show-current-part-handle (&optional mime-type)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
"Return an mm-handle for the part containing point.
This creates a temporary buffer for the part's content; the
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
caller is responsible for killing this buffer as appropriate. If
MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
emacs: Create an API for fetching parts as undecoded binary The new function, `notmuch-get-bodypart-binary', replaces `notmuch-get-bodypart-internal'. Whereas the old function was really meant for internal use in `notmuch-get-bodypart-content', it was used in a few other places. Since the difference between `notmuch-get-bodypart-content' and `notmuch-get-bodypart-internal' was unclear, these other uses were always confusing and potentially inconsistent. The new call clearly requests the part as undecoded binary. This is step 1 of 2 in separating `notmuch-get-bodypart-content' into two APIs for retrieving either undecoded binary or decoded text.
2015-01-24 22:16:57 +01:00
(let* ((msg (notmuch-show-get-message-properties))
(part (notmuch-show-get-part-properties))
(buf (notmuch-show-generate-part-buffer msg part))
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(computed-type (or mime-type (plist-get part :computed-type)))
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(filename (plist-get part :filename))
emacs: Use 'and' instead of 'when' when the return value matters Also do so for some 'if' forms that lack an ELSE part. Even go as far as using 'and' and 'not' instead of 'unless'.
2020-08-08 13:49:41 +02:00
(disposition (and filename `(attachment (filename . ,filename)))))
emacs: bugfix attachment content-type as mime-type handling Notmuch puts attachments in as declared content-type except when the content-type is application/octet-stream it tries to guess the type from the filename/extension. This means that viewing a pdf (for example) which is sent as application/octet-strem invokes the pdf viewer rather than just offering to save the part. Recent changes to the attachment handling (commit 1546387d) changed (broke) this. This patch stores the calculated mime-type with the part and changes the attachment part handlers can use it instead.
2013-07-31 20:39:05 +02:00
(mm-make-handle buf (list computed-type) nil nil disposition)))
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
"Apply FN to an mm-handle for the part containing point.
This ensures that the temporary buffer created for the mm-handle
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
is destroyed when FN returns. If MIME-TYPE is given then force
part to be treated as if it had that mime-type."
(let ((handle (notmuch-show-current-part-handle mime-type)))
emacs: more cleanup since dropping support for Emacs 24 Notmuch requires at least version 25 of Emacs now. Adjust comments that previously referenced version 24 specifically, even though they also apply to later releases. Remove documentation and code that no longer applies. - `mm-shr' no longer references `gnus-inhibit-images'.
2020-11-16 22:28:24 +01:00
;; Emacs puts stdout/stderr into the calling buffer so we call
;; it from a temp-buffer, unless notmuch-show-attachment-debug
;; is non-nil, in which case we put it in " *notmuch-part*".
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(unwind-protect
emacs: show: stop stderr appearing in buffer In emacs 24.3+ the stdout/stderr from externally displaying an attachment gets inserted into the show buffer. This is caused by changes in mm-display-external in mm-decode.el. Ideally, we would put this output in the notmuch errors buffer but the handler is called asynchronously so we don't know when the output will appear. Thus if we put it straight into the errors buffer it could get interleaved with other errors. Also we can't easily tell when we have got all the error output so can't wait until the process is complete. One solution would be to create a new buffer for the stderr of each attachment viewed. Again, since we can't tell when the process has finished, we can't close these buffers automatically so this will leave lots of buffers around. Thus we add a debug variable notmuch-show-attachment-debug: it this is non-nil we create a new buffer for each viewer; if this variable is nil we just use a temp buffer which means all error output is discarded (this is the same behaviour as with emacs pre 24.3).
2013-11-18 22:10:33 +01:00
(if notmuch-show-attachment-debug
(with-current-buffer (generate-new-buffer " *notmuch-part*")
(funcall fn handle))
(with-temp-buffer
(funcall fn handle)))
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(kill-buffer (mm-handle-buffer handle)))))
emacs/notmuch-show.el: Part headers are real buttons that save the part Convert the part headers into buttons that save the part when activated.
2010-04-21 22:19:19 +02:00
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
(defun notmuch-show-part-button-default (&optional button)
(interactive)
emacs: show: add invisibility button action This adds a button action to show hidden parts. In this version "RET" toggles the visibility of any part which puts content in the buffer (as opposed to attachments such as application/pdf). The button is used to hide parts when appropriate (eg text/html in multipart/alternative).
2012-12-18 20:27:59 +01:00
(let ((button (or button (button-at (point)))))
emacs: show: implement lazy hidden part handling This adds the actual code to do the lazy insertion of hidden parts. We use a memory inefficient but simple method: when we come to insert the part if it is hidden we just store all of the arguments to the part insertion function as a button property. This means when we want to show the part we can just resume where we left off. One thing is that we can't tell if a lazy part will produce text until we try to render it so when unhiding a part we check to see if it rendered; if not we invoke the default part handler (e.g. an external viewer). Also, we would like to insert the lazy part at the start of the line after the part button. But if this line has some text properties (e.g. the colours for a following message header) then the lazy part gets these properties. Thus we start at the end of the part button line, insert a newline, insert the lazy part, and then delete the extra newline at the end of the part.
2013-06-10 06:57:13 +02:00
;; Try to toggle the part, if that fails then call the default
;; action. The toggle fails if the part has no emacs renderable
;; content.
(unless (notmuch-show-toggle-part-invisibility button)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(call-interactively notmuch-show-part-button-default-action))))
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(defun notmuch-show-save-part ()
"Save the MIME part containing point to a file."
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
(interactive)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(notmuch-show-apply-to-current-part-handle #'mm-save-part))
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(defun notmuch-show-view-part ()
"View the MIME part containing point in an external viewer."
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
(interactive)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
;; Set mm-inlined-types to nil to force an external viewer
(let ((mm-inlined-types nil))
(notmuch-show-apply-to-current-part-handle #'mm-display-part)))
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(defun notmuch-show-interactively-view-part ()
"View the MIME part containing point, prompting for a viewer."
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
(interactive)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
Make buttons for attachments allow viewing as well as saving Define a keymap for attachment buttons to allow multiple actions. Define 3 possible actions: save attachment: exactly as currently, view attachment: uses mailcap entry, view attachment with user chosen program Keymap on a button is: s for save, v for view and o for view with other program. Default (i.e. enter or mouse button) is save but this is configurable in notmuch customize. One implementation detail: the view attachment function forces all attachments to be "displayed" using mailcap even if emacs could display them itself. Thus, for example, text/html appears in a browser and text/plain asks whether to save (on a standard debian setup)
2012-01-20 10:44:06 +01:00
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(defun notmuch-show-pipe-part ()
"Pipe the MIME part containing point to an external command."
emacs: add pipe attachment command Allow the user to pipe the attachment somewhere. Bound to '|' on the attachment button. Signed-off-by: Jameson Graef Rollins <jrollins@finestructure.net>
2012-05-07 09:02:09 +02:00
(interactive)
emacs: Simplify MIME part command implementation This unifies the part button actions and the underlying part action functions into single interactive command that simply applies to the part containing point using the just-added part p-list text property instead of button properties. Since all part actions can be performed by applying the appropriate mm function to an mm-handle, this patch abstracts out the creation of mm handles, making the implementations of the part commands trivial. This also eliminates our special handling for part save in favor of using the appropriate mm function. This necessarily modifies the way we handle the default part button action, but in a way that does not change the meaning of the notmuch-show-part-button-default-action defcustom. Since these commands are no longer specific to buttons, this patch eliminates the extra metadata stored with each button. This also eliminates one rather special-purpose macro for a collection of general purpose part handling utilities.
2013-05-30 03:13:46 +02:00
(notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
emacs: add pipe attachment command Allow the user to pipe the attachment somewhere. Bound to '|' on the attachment button. Signed-off-by: Jameson Graef Rollins <jrollins@finestructure.net>
2012-05-07 09:02:09 +02:00
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(defun notmuch-show--mm-display-part (handle)
"Use mm-display-part to display HANDLE in a new buffer.
If the part is displayed in an external application then close
the new buffer."
(let ((buf (get-buffer-create (generate-new-buffer-name
(concat " *notmuch-internal-part*")))))
emacs: Use pop-to-buffer-same-window rather than switch-to-buffer This means that notmuch commands obey display-buffer-alist so the user can customize how buffers show up. It also permits the use of C-x 4 4, C-x 5 5 and C-x t t, available in Emacs 28. For example, one can use C-x 4 4 M-x notmuch-jump-search RET to open a saved search in another window rather than the current window. Or in notmuch-search mode, C-x 5 5 RET to view the message at point in a new frame. notmuch-tree has custom buffer display logic, so bind display-buffer-overriding-action to make pop-to-buffer-same-window behave exactly as switch-to-buffer while that function is running.
2020-08-11 18:59:13 +02:00
(pop-to-buffer-same-window buf)
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(if (eq (mm-display-part handle) 'external)
(kill-buffer buf)
(goto-char (point-min))
(set-buffer-modified-p nil)
(view-buffer buf 'kill-buffer-if-not-modified))))
(defun notmuch-show-choose-mime-of-part (mime-type)
emacs docstrings: consistent indentation, newlines, periods Fixed emacs docstrings to be consistent. No functional change. - removed some (accidental) indentation - removed some trailing newlines - added trailing periods where missing (some exclusions)
2020-05-24 21:17:56 +02:00
"Choose the mime type to use for displaying part."
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
(interactive
(list (completing-read "Mime type to use (default text/plain): "
(mailcap-mime-types) nil nil nil nil "text/plain")))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
mime-type))
emacs: show: let the user override the mime-type of an attachment This allows the user to override the mime-type of a part in the show buffer. This takes the simple option of displaying the part with the specified mime-type in its own buffer (in view mode). This avoids further complicating the part handling code. Bound to ". m" (i.e., m in the part map). Then the user can either enter a mime-type (with completion to all mime types that mailcap (and thus notmuch) knows about, or press return for the default choice of text/plain.
2016-07-11 09:49:19 +02:00
Add Emacs' imenu support in notmuch-show and notmuch-search Emacs' major modes can facilitate navigation in their buffers by supporting Imenu. In such major modes, launching Imenu (M-x imenu) makes Emacs display a list of items (e.g., function definitions in a code buffer). Selecting an item from this list moves point to this item. This patch adds Imenu support to both notmuch-show and notmuch-search buffers: * in notmuch-show, Imenu will present a list of all messages in the currently visible thread; * in notmuch-search, Imenu will present a list of all messages in the search buffer.
2017-06-12 15:30:10 +02:00
(defun notmuch-show-imenu-prev-index-position-function ()
"Move point to previous message in notmuch-show buffer.
This function is used as a value for
`imenu-prev-index-position-function'."
(if (bobp)
nil
(notmuch-show-previous-message)
t))
(defun notmuch-show-imenu-extract-index-name-function ()
"Return imenu name for line at point.
This function is used as a value for
`imenu-extract-index-name-function'. Point should be at the
beginning of the line."
(back-to-indentation)
Add indentation to imenu in notmuch-show
2017-06-18 12:04:35 +02:00
(buffer-substring-no-properties (if notmuch-show-imenu-indent
(line-beginning-position)
(point))
(line-end-position)))
Add Emacs' imenu support in notmuch-show and notmuch-search Emacs' major modes can facilitate navigation in their buffers by supporting Imenu. In such major modes, launching Imenu (M-x imenu) makes Emacs display a list of items (e.g., function definitions in a code buffer). Selecting an item from this list moves point to this item. This patch adds Imenu support to both notmuch-show and notmuch-search buffers: * in notmuch-show, Imenu will present a list of all messages in the currently visible thread; * in notmuch-search, Imenu will present a list of all messages in the search buffer.
2017-06-12 15:30:10 +02:00
emacs: Easy access to URLs mentioned in the current message Add a new binding when looking at messages, B, that prompts with a list of URLs found in the current message, if any. Open the one that is selected in a browser. amended by db: s/--browse-urls/-browse-urls/
2018-11-08 11:45:08 +01:00
(defmacro notmuch-show--with-currently-shown-message (&rest body)
"Evaluate BODY with display restricted to the currently shown
message."
`(save-excursion
(save-restriction
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
(let ((extent (notmuch-show-message-extent)))
(narrow-to-region (car extent) (cdr extent))
,@body))))
emacs: Easy access to URLs mentioned in the current message Add a new binding when looking at messages, B, that prompts with a list of URLs found in the current message, if any. Open the one that is selected in a browser. amended by db: s/--browse-urls/-browse-urls/
2018-11-08 11:45:08 +01:00
(defun notmuch-show--gather-urls ()
"Gather any URLs in the current message."
(notmuch-show--with-currently-shown-message
(let (urls)
(goto-char (point-min))
(while (re-search-forward goto-address-url-regexp (point-max) t)
(push (match-string-no-properties 0) urls))
(reverse urls))))
emacs: A prefix argument kills rather than browsing URLs In `notmuch-show', the "B" key (notmuch-show-browse-urls) will kill the URL if called with a prefix argument rather than browsing directly.
2019-12-02 11:48:05 +01:00
(defun notmuch-show-browse-urls (&optional kill)
"Offer to browse any URLs in the current message.
With a prefix argument, copy the URL to the kill ring rather than
browsing."
(interactive "P")
(let ((urls (notmuch-show--gather-urls))
(prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
(fn (if kill #'kill-new #'browse-url)))
emacs: Easy access to URLs mentioned in the current message Add a new binding when looking at messages, B, that prompts with a list of URLs found in the current message, if any. Open the one that is selected in a browser. amended by db: s/--browse-urls/-browse-urls/
2018-11-08 11:45:08 +01:00
(if urls
emacs: use def instead of initial-input for notmuch-show-browse-urls This is the non-deprecated way to use completing-read. Additionally the old use was broken when using ivy for completing-read. For user's using completing-read-default they won't see the default URL now, but if they hit enter it will be visited. Alternatively they can select it with M-n. From the completing-read documentation for initial-input: This feature is deprecated--it is best to pass nil for INITIAL-INPUT and supply the default value DEF instead. The user can yank the default value into the minibuffer easily using M-n. Additionally collection is now all urls, rather than all but the first. I'm not sure why "(cdr urls)" was previously done.
2020-04-13 21:58:19 +02:00
(funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
emacs: Easy access to URLs mentioned in the current message Add a new binding when looking at messages, B, that prompts with a list of URLs found in the current message, if any. Open the one that is selected in a browser. amended by db: s/--browse-urls/-browse-urls/
2018-11-08 11:45:08 +01:00
(message "No URLs found."))))
emacs: make headings outline-minor-mode compatible `outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future.
2021-01-10 15:00:46 +01:00
;;; _
emacs: Move notmuch-show functionality to notmuch-show.el To ease the transition to a JSON based implementation of `notmuch-show', move the current implementation into a separate file. Create `notmuch-lib.el' to hold common variables.
2010-04-01 19:36:21 +02:00
(provide 'notmuch-show)
emacs: Fix packaging Refer to (info "(elisp) Library Headers") for package conventions.
2016-04-13 09:58:47 +02:00
;;; notmuch-show.el ends here
Reference in a new issue Copy permalink