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

422 lines
15 KiB
EmacsLisp
Raw 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-wash.el --- cleaning up message bodies -*- lexical-binding: t -*-
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
;;
;; Copyright © Carl Worth
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
;; Copyright © David Edmondson
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
;;
;; 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 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
;;
;; Authors: Carl Worth <cworth@cworth.org>
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
;; David Edmondson <dme@dme.org>
emacs: Fix packaging Refer to (info "(elisp) Library Headers") for package conventions.
2016-04-13 09:58:47 +02:00
;;; Code:
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
(require 'coolj)
emacs: require notmuch-lib from notmuch-wash.el This is needed so that notmuch-wash.el is loadable by itself; in particular for the docstring processing.
2018-06-14 02:32:36 +02:00
(require 'notmuch-lib)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(declare-function notmuch-show-insert-bodypart "notmuch-show"
(msg part depth &optional hide))
emacs: wash: word-wrap bugfix Previously notmuch-wash made the width of the text (approximately) the window-width minus the depth in thread. This is correct for the default indentation of 1 per message depth, but is incorrect for any other setting of notmuch-show-indent-messages-width. As notmuch-show-indent-messages-width is customisable, and notmuch-tree sets it to zero to avoid indenting messages in the message pane, this bug can show up in real use. Two of the tests had to be updated: when notmuch-show-indent-messages-width is 0, then the new (correct) word wrapping happens later, when notmuch-show-indent-messages-width is 4, then the new word wrapping happens sooner.
2016-08-06 17:29:33 +02:00
(defvar notmuch-show-indent-messages-width)
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
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: 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: More flexible washed faces. The faces used when washing messages should be notmuch specific and inherit from the underlying emacs face rather than using it directly. This allows the washed face to be modified without requiring the modification of the underlying face.
2014-10-31 09:05:20 +01:00
(defgroup notmuch-wash nil
"Cleaning up messages for display."
:group 'notmuch)
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-signature-regexp "^\\(-- ?\\|_+\\)$"
"Pattern to match a line that separates content from signature."
:type 'regexp
:group 'notmuch-wash)
(defcustom notmuch-wash-citation-regexp "\\(^[[:space:]]*>.*\n\\)+"
"Pattern to match citation lines."
:type 'regexp
:group 'notmuch-wash)
(defcustom notmuch-wash-original-regexp "^\\(--+\s?[oO]riginal [mM]essage\s?--+\\)$"
"Pattern to match a line that separates original message from
reply in top-posted message."
:type 'regexp
:group 'notmuch-wash)
(defcustom notmuch-wash-button-signature-hidden-format
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
"[ %d-line signature. Click/Enter to show. ]"
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
"String used to construct button text for hidden signatures.
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
Can use up to one integer format parameter, i.e. %d."
:type 'string
:group 'notmuch-wash)
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: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-button-signature-visible-format
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
"[ %d-line signature. Click/Enter to hide. ]"
"String used to construct button text for visible signatures.
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
Can use up to one integer format parameter, i.e. %d."
:type 'string
:group 'notmuch-wash)
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-button-citation-hidden-format
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
"[ %d more citation lines. Click/Enter to show. ]"
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
"String used to construct button text for hidden citations.
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
Can use up to one integer format parameter, i.e. %d."
:type 'string
:group 'notmuch-wash)
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: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-button-citation-visible-format
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
"[ %d more citation lines. Click/Enter to hide. ]"
"String used to construct button text for visible citations.
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
Can use up to one integer format parameter, i.e. %d."
:type 'string
:group 'notmuch-wash)
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-button-original-hidden-format
notmuch.el: hide original message in top posted replies. This code treats top posted copies essentially like signatures, except that it doesn't sanity check their length, since neither do their senders. New user-visible variables: notmuch-wash-button-original-hidden-format notmuch-wash-button-original-visible-format Rebased-by: Carl Worth <cworth@cworth.org>
2010-02-24 19:30:06 +01:00
"[ %d-line hidden original message. Click/Enter to show. ]"
"String used to construct button text for hidden citations.
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
Can use up to one integer format parameter, i.e. %d."
:type 'string
:group 'notmuch-wash)
notmuch.el: hide original message in top posted replies. This code treats top posted copies essentially like signatures, except that it doesn't sanity check their length, since neither do their senders. New user-visible variables: notmuch-wash-button-original-hidden-format notmuch-wash-button-original-visible-format Rebased-by: Carl Worth <cworth@cworth.org>
2010-02-24 19:30:06 +01:00
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-button-original-visible-format
notmuch.el: hide original message in top posted replies. This code treats top posted copies essentially like signatures, except that it doesn't sanity check their length, since neither do their senders. New user-visible variables: notmuch-wash-button-original-hidden-format notmuch-wash-button-original-visible-format Rebased-by: Carl Worth <cworth@cworth.org>
2010-02-24 19:30:06 +01:00
"[ %d-line original message. Click/Enter to hide. ]"
"String used to construct button text for visible citations.
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
Can use up to one integer format parameter, i.e. %d."
:type 'string
:group 'notmuch-wash)
notmuch.el: hide original message in top posted replies. This code treats top posted copies essentially like signatures, except that it doesn't sanity check their length, since neither do their senders. New user-visible variables: notmuch-wash-button-original-hidden-format notmuch-wash-button-original-visible-format Rebased-by: Carl Worth <cworth@cworth.org>
2010-02-24 19:30:06 +01:00
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-signature-lines-max 12
"Maximum length of signature that will be hidden by default."
:type 'integer
:group 'notmuch-wash)
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: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-citation-lines-prefix 3
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
"Always show at least this many lines from the start of a citation.
If there is one more line than the sum of
`notmuch-wash-citation-lines-prefix' and
`notmuch-wash-citation-lines-suffix', show that, otherwise
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
collapse the remaining lines into a button."
:type 'integer
:group 'notmuch-wash)
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: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-citation-lines-suffix 3
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
"Always show at least this many lines from the end of a citation.
If there is one more line than the sum of
`notmuch-wash-citation-lines-prefix' and
`notmuch-wash-citation-lines-suffix', show that, otherwise
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
collapse the remaining lines into a button."
:type 'integer
:group 'notmuch-wash)
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: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
(defcustom notmuch-wash-wrap-lines-length nil
emacs: Add configurable wrapping width for notmuch-wash-wrap-long-lines This introduces a variable to control after how many characters a line is wrapped by notmuch-wash-wrap-long-lines (still wrapping at the window width if it is lower).
2012-02-17 19:34:44 +01:00
"Wrap line after at most this many characters.
If this is nil, lines in messages will be wrapped to fit in the
current window. If this is a number, lines will be wrapped after
emacs: wash: make word-wrap bound message width Previously if notmuch-wash-wrap-lines-length was set then all messages would be wrapped at this value (or window-width if that is smaller). This was done regardless of the message's depth in a thread -- for example, if the n.w.w.l.l is 80 and the messages depth is 20 (so indented 20 by default) the messages text only got 60 characters of space. This commit changes that so a message always gets the full n.w.w.l.l of width regardless of its indentation (unless that goes over window-width of course).
2016-08-06 17:29:34 +02:00
this many characters (ignoring indentation due to thread depth)
or at the window width (whichever one is lower)."
emacs: Washing should use more `defcustom'. More of the washing variables should be available through the standard customisation interface.
2014-10-31 09:05:21 +01:00
:type '(choice (const :tag "window width" nil)
(integer :tag "number of characters"))
:group 'notmuch-wash)
emacs: Add configurable wrapping width for notmuch-wash-wrap-long-lines This introduces a variable to control after how many characters a line is wrapped by notmuch-wash-wrap-long-lines (still wrapping at the window width if it is lower).
2012-02-17 19:34:44 +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
;;; Faces
emacs: More flexible washed faces. The faces used when washing messages should be notmuch specific and inherit from the underlying emacs face rather than using it directly. This allows the washed face to be modified without requiring the modification of the underlying face.
2014-10-31 09:05:20 +01:00
(defface notmuch-wash-toggle-button
'((t (:inherit font-lock-comment-face)))
"Face used for buttons toggling the visibility of washed away
message parts."
:group 'notmuch-wash
:group 'notmuch-faces)
(defface notmuch-wash-cited-text
'((t (:inherit message-cited-text)))
"Face used for cited text."
:group 'notmuch-wash
:group 'notmuch-faces)
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
;;; Buttons
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
(defun notmuch-wash-toggle-invisible-action (cite-button)
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
;; Toggle overlay visibility
(let ((overlay (button-get cite-button 'overlay)))
(overlay-put overlay 'invisible (not (overlay-get overlay 'invisible))))
;; Update button text
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
(let* ((new-start (button-start cite-button))
(overlay (button-get cite-button 'overlay))
(button-label (notmuch-wash-button-label overlay))
Carefully manage save/restore of point in `notmuch-wash-toggle-invisible-action'. Before the change, save-excursion was used to save the point. But the marker saved by save-excursion was inside a region that was deleted, so that approach is unreliable, (leading to point jumping to a new position past the button). This patch instead saves point in an integer variable, and when restoring, carefully avoids moving point past the button, (in case the new button label is shorter than the old button label).
2011-05-25 01:02:43 +02:00
(old-point (point))
emacs: Retain text properties when toggling buttons Previously, we lost any text properties applied to part buttons or wash buttons when they were toggled because `insert' directly copies the text properties of the string being inserted. Fix this by capturing the properties applied to the button beforehand and re-applying them after inserting the new text.
2013-05-30 03:13:44 +02:00
(properties (text-properties-at (point)))
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
(inhibit-read-only t))
Carefully manage save/restore of point in `notmuch-wash-toggle-invisible-action'. Before the change, save-excursion was used to save the point. But the marker saved by save-excursion was inside a region that was deleted, so that approach is unreliable, (leading to point jumping to a new position past the button). This patch instead saves point in an integer variable, and when restoring, carefully avoids moving point past the button, (in case the new button label is shorter than the old button label).
2011-05-25 01:02:43 +02:00
(goto-char new-start)
(insert button-label)
emacs: Retain text properties when toggling buttons Previously, we lost any text properties applied to part buttons or wash buttons when they were toggled because `insert' directly copies the text properties of the string being inserted. Fix this by capturing the properties applied to the button beforehand and re-applying them after inserting the new text.
2013-05-30 03:13:44 +02:00
(set-text-properties new-start (point) properties)
Carefully manage save/restore of point in `notmuch-wash-toggle-invisible-action'. Before the change, save-excursion was used to save the point. But the marker saved by save-excursion was inside a region that was deleted, so that approach is unreliable, (leading to point jumping to a new position past the button). This patch instead saves point in an integer variable, and when restoring, carefully avoids moving point past the button, (in case the new button label is shorter than the old button label).
2011-05-25 01:02:43 +02:00
(let ((old-end (button-end cite-button)))
(move-overlay cite-button new-start (point))
(delete-region (point) old-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
(goto-char (min old-point (1- (button-end cite-button))))))
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
(define-button-type 'notmuch-wash-button-invisibility-toggle-type
'action 'notmuch-wash-toggle-invisible-action
'follow-link t
emacs: More flexible washed faces. The faces used when washing messages should be notmuch specific and inherit from the underlying emacs face rather than using it directly. This allows the washed face to be modified without requiring the modification of the underlying face.
2014-10-31 09:05:20 +01:00
'face 'notmuch-wash-toggle-button
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
:supertype 'notmuch-button-type)
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
(define-button-type 'notmuch-wash-button-citation-toggle-type
'help-echo "mouse-1, RET: Show citation"
:supertype 'notmuch-wash-button-invisibility-toggle-type)
(define-button-type 'notmuch-wash-button-signature-toggle-type
'help-echo "mouse-1, RET: Show signature"
:supertype 'notmuch-wash-button-invisibility-toggle-type)
notmuch.el: hide original message in top posted replies. This code treats top posted copies essentially like signatures, except that it doesn't sanity check their length, since neither do their senders. New user-visible variables: notmuch-wash-button-original-hidden-format notmuch-wash-button-original-visible-format Rebased-by: Carl Worth <cworth@cworth.org>
2010-02-24 19:30:06 +01:00
(define-button-type 'notmuch-wash-button-original-toggle-type
'help-echo "mouse-1, RET: Show original message"
:supertype 'notmuch-wash-button-invisibility-toggle-type)
emacs: Fix i-search to open up invisible citations as necessary Add an `isearch-open-invisible' property to the overlays used to hide citations and signatures, together with an appropriate function to leave the invisible text visible should that be required.
2010-04-23 19:39:33 +02:00
(defun notmuch-wash-region-isearch-show (overlay)
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
(notmuch-wash-toggle-invisible-action
(overlay-get overlay 'notmuch-wash-button)))
emacs: Fix i-search to open up invisible citations as necessary Add an `isearch-open-invisible' property to the overlays used to hide citations and signatures, together with an appropriate function to leave the invisible text visible should that be required.
2010-04-23 19:39:33 +02:00
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
(defun notmuch-wash-button-label (overlay)
(let* ((type (overlay-get overlay 'type))
(invis-spec (overlay-get overlay 'invisible))
(state (if (invisible-p invis-spec) "hidden" "visible"))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(label-format (symbol-value
(intern-soft
(format "notmuch-wash-button-%s-%s-format"
type state))))
(lines-count (count-lines (overlay-start overlay)
(overlay-end overlay))))
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
(format label-format lines-count)))
emacs: notmuch-wash-region-to-button: remove unused MSG argument
2021-01-10 15:00:51 +01:00
(defun notmuch-wash-region-to-button (beg end type &optional prefix)
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
"Auxiliary function to do the actual making of overlays and buttons.
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
BEG and END are buffer locations. TYPE should a string, either
emacs: fix `notmuch-wash-region-to-button' to work at beginning of buffer `Notmuch-wash-region-to-button' is the function that creates hidden regions with buttons for signatures, citations and original messages. Before the change, it did not work correctly if the to-be-hidden region started at the beginning of a message: the visibility toggle button was hidden as well. The patch fixes this. There are two parts in the fix: * Use `insert-before-markers' instead of `insert' for creating the button, so that it does not get added to the hidden overlay. * Stop using PREFIX argument for adding a newline before the button. The newline should not be added before a button at the beginning of buffer. The corresponding test is fixed now.
2012-02-04 08:36:37 +01:00
\"citation\" or \"signature\". Optional PREFIX is some arbitrary
text to insert before the button, probably for indentation. Note
that PREFIX should not include a newline."
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
;; This uses some slightly tricky conversions between strings and
;; symbols because of the way the button code works. Note that
;; replacing intern-soft with make-symbol will cause this to fail,
;; since the newly created symbol has no plist.
(let ((overlay (make-overlay beg end))
(button-type (intern-soft (concat "notmuch-wash-button-"
type "-toggle-type"))))
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 overlay 'invisible t)
emacs: Fix i-search to open up invisible citations as necessary Add an `isearch-open-invisible' property to the overlays used to hide citations and signatures, together with an appropriate function to leave the invisible text visible should that be required.
2010-04-23 19:39:33 +02:00
(overlay-put overlay 'isearch-open-invisible #'notmuch-wash-region-isearch-show)
Use different labels for wash buttons when text is visible or hidden. Before the change, citation and signature wash buttons used the same label in both visible and hidden states. Sometimes it is very convenient when you can determine if the text is hidden or shown without reading the context and/or clicking the button. The patch makes it easy to see if the text is shown or hidden by explicitly saying what the button does (shows or hides the text).
2011-05-22 20:57:53 +02:00
(overlay-put overlay 'type type)
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
(goto-char (1+ end))
(save-excursion
emacs: fix `notmuch-wash-region-to-button' to work at beginning of buffer `Notmuch-wash-region-to-button' is the function that creates hidden regions with buttons for signatures, citations and original messages. Before the change, it did not work correctly if the to-be-hidden region started at the beginning of a message: the visibility toggle button was hidden as well. The patch fixes this. There are two parts in the fix: * Use `insert-before-markers' instead of `insert' for creating the button, so that it does not get added to the hidden overlay. * Stop using PREFIX argument for adding a newline before the button. The newline should not be added before a button at the beginning of buffer. The corresponding test is fixed now.
2012-02-04 08:36:37 +01:00
(goto-char beg)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when prefix
(insert-before-markers prefix))
emacs: fix `notmuch-wash-region-to-button' to work at beginning of buffer `Notmuch-wash-region-to-button' is the function that creates hidden regions with buttons for signatures, citations and original messages. Before the change, it did not work correctly if the to-be-hidden region started at the beginning of a message: the visibility toggle button was hidden as well. The patch fixes this. There are two parts in the fix: * Use `insert-before-markers' instead of `insert' for creating the button, so that it does not get added to the hidden overlay. * Stop using PREFIX argument for adding a newline before the button. The newline should not be added before a button at the beginning of buffer. The corresponding test is fixed now.
2012-02-04 08:36:37 +01:00
(let ((button-beg (point)))
(insert-before-markers (notmuch-wash-button-label overlay) "\n")
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
(let ((button (make-button button-beg (1- (point))
'overlay overlay
:type button-type)))
(overlay-put overlay 'notmuch-wash-button button))))))
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: 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
;;; Hook functions
emacs: silence compiler wrt notmuch-show-insert-part-text/plain `notmuch-show-insert-part-text/plain' calls `notmuch-show-insert-text/plain-hook' with two arguments MSG and DEPTH. Currently all hook functions ignore MSG but third-party functions may not. One hook function uses DEPTH.
2021-01-10 15:00:52 +01:00
(defun notmuch-wash-excerpt-citations (_msg _depth)
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
"Excerpt citations and up to one signature."
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
(goto-char (point-min))
(beginning-of-line)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (and (< (point) (point-max))
(re-search-forward notmuch-wash-original-regexp nil t))
emacs: notmuch-wash-region-to-button: remove unused MSG argument
2021-01-10 15:00:51 +01:00
(notmuch-wash-region-to-button (match-beginning 0)
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
(point-max)
"original"))
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
(while (and (< (point) (point-max))
(re-search-forward notmuch-wash-citation-regexp nil t))
(let* ((cite-start (match-beginning 0))
(cite-end (match-end 0))
(cite-lines (count-lines cite-start cite-end)))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(overlay-put (make-overlay cite-start cite-end)
'face 'notmuch-wash-cited-text)
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
(when (> cite-lines (+ notmuch-wash-citation-lines-prefix
notmuch-wash-citation-lines-suffix
1))
(goto-char cite-start)
(forward-line notmuch-wash-citation-lines-prefix)
(let ((hidden-start (point-marker)))
(goto-char cite-end)
(forward-line (- notmuch-wash-citation-lines-suffix))
(notmuch-wash-region-to-button
emacs: notmuch-wash-region-to-button: remove unused MSG argument
2021-01-10 15:00:51 +01:00
hidden-start (point-marker)
emacs: fix `notmuch-wash-region-to-button' to work at beginning of buffer `Notmuch-wash-region-to-button' is the function that creates hidden regions with buttons for signatures, citations and original messages. Before the change, it did not work correctly if the to-be-hidden region started at the beginning of a message: the visibility toggle button was hidden as well. The patch fixes this. There are two parts in the fix: * Use `insert-before-markers' instead of `insert' for creating the button, so that it does not get added to the hidden overlay. * Stop using PREFIX argument for adding a newline before the button. The newline should not be added before a button at the beginning of buffer. The corresponding test is fixed now.
2012-02-04 08:36:37 +01:00
"citation")))))
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (and (not (eobp))
(re-search-forward notmuch-wash-signature-regexp nil 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
(let ((sig-start (match-beginning 0)))
(when (<= (count-lines sig-start (point-max))
notmuch-wash-signature-lines-max)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(let ((sig-start-marker (make-marker))
(sig-end-marker (make-marker)))
(set-marker sig-start-marker sig-start)
(set-marker sig-end-marker (point-max))
(overlay-put (make-overlay sig-start-marker sig-end-marker)
'face 'message-cited-text)
(notmuch-wash-region-to-button
emacs: notmuch-wash-region-to-button: remove unused MSG argument
2021-01-10 15:00:51 +01:00
sig-start-marker sig-end-marker
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
"signature"))))))
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: silence compiler wrt notmuch-show-insert-part-text/plain `notmuch-show-insert-part-text/plain' calls `notmuch-show-insert-text/plain-hook' with two arguments MSG and DEPTH. Currently all hook functions ignore MSG but third-party functions may not. One hook function uses DEPTH.
2021-01-10 15:00:52 +01:00
(defun notmuch-wash-elide-blank-lines (_msg _depth)
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
"Elide leading, trailing and successive blank lines."
;; Algorithm derived from `article-strip-multiple-blank-lines' in
;; `gnus-art.el'.
;; Make all blank lines empty.
(goto-char (point-min))
(while (re-search-forward "^[[:space:]\t]+$" nil t)
(replace-match "" nil t))
;; Replace multiple empty lines with a single empty line.
(goto-char (point-min))
(while (re-search-forward "^\n\\(\n+\\)" nil t)
(delete-region (match-beginning 1) (match-end 1)))
;; Remove a leading blank line.
(goto-char (point-min))
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (looking-at "\n")
(delete-region (match-beginning 0) (match-end 0)))
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
;; Remove a trailing blank line.
(goto-char (point-max))
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (looking-at "\n")
(delete-region (match-beginning 0) (match-end 0))))
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
emacs: silence compiler wrt notmuch-show-insert-part-text/plain `notmuch-show-insert-part-text/plain' calls `notmuch-show-insert-text/plain-hook' with two arguments MSG and DEPTH. Currently all hook functions ignore MSG but third-party functions may not. One hook function uses DEPTH.
2021-01-10 15:00:52 +01:00
(defun notmuch-wash-tidy-citations (_msg _depth)
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
"Improve the display of cited regions of a message.
emacs: Remove over-eager regular expressions from notmuch-wash-tidy-citations. The removed expressions, which were used to ensure that citations were both preceded and followed by a blank line, were poorly implemented and caused a regexp stack overflow on messages more than a few thousand lines long.
2010-11-17 14:32:33 +01:00
Perform several transformations on the message body:
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
- Remove lines of repeated citation leaders with no other
content,
- Remove citation leaders standing alone before a block of cited
text,
- Remove citation trailers standing alone after a block of cited
text."
;; Remove lines of repeated citation leaders with no other content.
(goto-char (point-min))
(while (re-search-forward "\\(^>[> ]*\n\\)\\{2,\\}" nil t)
(replace-match "\\1"))
emacs: Remove excess empty lines Most people who write lots of lisp tend to only sparsely use empty "separator" lines within forms. In lisp they feel unnecessary and since most files stick to this convention we get a bit confused when there are extra empty lines. It feels like the s-expressions are falling into pieces. All of this is especially true between a function's doc-string and body because the doc-string is colored differently, which visually already separates it quite sufficiently from the code that follows.
2020-08-08 13:49:37 +02:00
;; Remove citation leaders standing alone before a block of cited text.
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
(goto-char (point-min))
(while (re-search-forward "\\(\n\\|^[^>].*\\)\n\\(^>[> ]*\n\\)" nil t)
(replace-match "\\1\n"))
emacs: Remove excess empty lines Most people who write lots of lisp tend to only sparsely use empty "separator" lines within forms. In lisp they feel unnecessary and since most files stick to this convention we get a bit confused when there are extra empty lines. It feels like the s-expressions are falling into pieces. All of this is especially true between a function's doc-string and body because the doc-string is colored differently, which visually already separates it quite sufficiently from the code that follows.
2020-08-08 13:49:37 +02:00
;; Remove citation trailers standing alone after a block of cited text.
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
(goto-char (point-min))
(while (re-search-forward "\\(^>[> ]*\n\\)\\(^$\\|^[^>].*\\)" nil t)
emacs: Remove over-eager regular expressions from notmuch-wash-tidy-citations. The removed expressions, which were used to ensure that citations were both preceded and followed by a blank line, were poorly implemented and caused a regexp stack overflow on messages more than a few thousand lines long.
2010-11-17 14:32:33 +01:00
(replace-match "\\2")))
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
emacs: silence compiler wrt notmuch-show-insert-part-text/plain `notmuch-show-insert-part-text/plain' calls `notmuch-show-insert-text/plain-hook' with two arguments MSG and DEPTH. Currently all hook functions ignore MSG but third-party functions may not. One hook function uses DEPTH.
2021-01-10 15:00:52 +01:00
(defun notmuch-wash-wrap-long-lines (_msg depth)
emacs: Add configurable wrapping width for notmuch-wash-wrap-long-lines This introduces a variable to control after how many characters a line is wrapped by notmuch-wash-wrap-long-lines (still wrapping at the window width if it is lower).
2012-02-17 19:34:44 +01:00
"Wrap long lines in the message.
If `notmuch-wash-wrap-lines-length' is a number, this will wrap
the message lines to the minimum of the width of the window or
its value. Otherwise, this function will wrap long lines in the
message at the window width. When doing so, citation leaders in
the wrapped text are maintained."
(let* ((coolj-wrap-follows-window-size nil)
emacs: wash: word-wrap bugfix Previously notmuch-wash made the width of the text (approximately) the window-width minus the depth in thread. This is correct for the default indentation of 1 per message depth, but is incorrect for any other setting of notmuch-show-indent-messages-width. As notmuch-show-indent-messages-width is customisable, and notmuch-tree sets it to zero to avoid indenting messages in the message pane, this bug can show up in real use. Two of the tests had to be updated: when notmuch-show-indent-messages-width is 0, then the new (correct) word wrapping happens later, when notmuch-show-indent-messages-width is 4, then the new word wrapping happens sooner.
2016-08-06 17:29:33 +02:00
(indent (* depth notmuch-show-indent-messages-width))
emacs: Add configurable wrapping width for notmuch-wash-wrap-long-lines This introduces a variable to control after how many characters a line is wrapped by notmuch-wash-wrap-long-lines (still wrapping at the window width if it is lower).
2012-02-17 19:34:44 +01:00
(limit (if (numberp notmuch-wash-wrap-lines-length)
emacs: wash: make word-wrap bound message width Previously if notmuch-wash-wrap-lines-length was set then all messages would be wrapped at this value (or window-width if that is smaller). This was done regardless of the message's depth in a thread -- for example, if the n.w.w.l.l is 80 and the messages depth is 20 (so indented 20 by default) the messages text only got 60 characters of space. This commit changes that so a message always gets the full n.w.w.l.l of width regardless of its indentation (unless that goes over window-width of course).
2016-08-06 17:29:34 +02:00
(min (+ notmuch-wash-wrap-lines-length indent)
emacs: Add configurable wrapping width for notmuch-wash-wrap-long-lines This introduces a variable to control after how many characters a line is wrapped by notmuch-wash-wrap-long-lines (still wrapping at the window width if it is lower).
2012-02-17 19:34:44 +01:00
(window-width))
(window-width)))
(fill-column (- limit
emacs: wash: word-wrap bugfix Previously notmuch-wash made the width of the text (approximately) the window-width minus the depth in thread. This is correct for the default indentation of 1 per message depth, but is incorrect for any other setting of notmuch-show-indent-messages-width. As notmuch-show-indent-messages-width is customisable, and notmuch-tree sets it to zero to avoid indenting messages in the message pane, this bug can show up in real use. Two of the tests had to be updated: when notmuch-show-indent-messages-width is 0, then the new (correct) word wrapping happens later, when notmuch-show-indent-messages-width is 4, then the new word wrapping happens sooner.
2016-08-06 17:29:33 +02:00
indent
emacs: Add configurable wrapping width for notmuch-wash-wrap-long-lines This introduces a variable to control after how many characters a line is wrapped by notmuch-wash-wrap-long-lines (still wrapping at the window width if it is lower).
2012-02-17 19:34:44 +01:00
;; 2 to avoid poor interaction with
;; `word-wrap'.
2)))
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
(coolj-wrap-region (point-min) (point-max))))
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
;;;; Convert Inline Patches
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
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
(require 'diff-mode)
(defvar diff-file-header-re) ; From `diff-mode.el'.
emacs: create patch filename from subject for inline patch fake parts Use the mail subject line for creating a descriptive filename for the wash generated inline patch fake parts. The names are similar to the ones created by 'git format-patch'. If the user has notmuch-wash-convert-inline-patch-to-part hook enabled in notmuch-show-insert-text/plain-hook, this will change the old default filename of "inline patch" in fake parts: [ inline patch: inline patch (as text/x-diff) ] into, for example: [ 0002-emacs-create-patch-filename-from-subject-for-inline.patch: inline patch (as text/x-diff) ] which is typically the same filename the sender had if he was using 'git format-patch' and 'git send-email'. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-12-27 17:04:39 +01:00
(defun notmuch-wash-subject-to-filename (subject &optional maxlen)
"Convert a mail SUBJECT into a filename.
The resulting filename is similar to the names generated by \"git
format-patch\", without the leading patch sequence number
\"0001-\" and \".patch\" extension. Any leading \"[PREFIX]\"
style strings are removed prior to conversion.
Optional argument MAXLEN is the maximum length of the resulting
filename, before trimming any trailing . and - characters."
(let* ((s (replace-regexp-in-string "^ *\\(\\[[^]]*\\] *\\)*" "" subject))
(s (replace-regexp-in-string "[^A-Za-z0-9._]+" "-" s))
(s (replace-regexp-in-string "\\.+" "." s))
(s (if maxlen (substring s 0 (min (length s) maxlen)) s))
(s (replace-regexp-in-string "[.-]*$" "" s)))
s))
(defun notmuch-wash-subject-to-patch-sequence-number (subject)
"Convert a patch mail SUBJECT into a patch sequence number.
Return the patch sequence number N from the last \"[PATCH N/M]\"
style prefix in SUBJECT, or nil if such a prefix can't be found."
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 (string-match
"^ *\\(\\[[^]]*\\] *\\)*\\[[^]]*?\\([0-9]+\\)/[0-9]+[^]]*\\].*"
subject)
(string-to-number (substring subject (match-beginning 2) (match-end 2)))))
emacs: create patch filename from subject for inline patch fake parts Use the mail subject line for creating a descriptive filename for the wash generated inline patch fake parts. The names are similar to the ones created by 'git format-patch'. If the user has notmuch-wash-convert-inline-patch-to-part hook enabled in notmuch-show-insert-text/plain-hook, this will change the old default filename of "inline patch" in fake parts: [ inline patch: inline patch (as text/x-diff) ] into, for example: [ 0002-emacs-create-patch-filename-from-subject-for-inline.patch: inline patch (as text/x-diff) ] which is typically the same filename the sender had if he was using 'git format-patch' and 'git send-email'. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-12-27 17:04:39 +01:00
(defun notmuch-wash-subject-to-patch-filename (subject)
"Convert a patch mail SUBJECT into a filename.
The resulting filename is similar to the names generated by \"git
format-patch\". If the patch mail was generated and sent using
\"git format-patch/send-email\", this should re-create the
original filename the sender had."
(format "%04d-%s.patch"
(or (notmuch-wash-subject-to-patch-sequence-number subject) 1)
(notmuch-wash-subject-to-filename subject 52)))
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
(defun notmuch-wash-convert-inline-patch-to-part (msg depth)
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
"Convert an inline patch into a fake 'text/x-diff' attachment.
Given that this function guesses whether a buffer includes a
patch and then guesses the extent of the patch, there is scope
for error."
(goto-char (point-min))
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 (re-search-forward diff-file-header-re nil t)
(beginning-of-line -1)
(let ((patch-start (point))
(patch-end (point-max))
part)
(goto-char patch-start)
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (or
;; Patch ends with signature.
(re-search-forward notmuch-wash-signature-regexp nil t)
;; Patch ends with bugtraq comment.
(re-search-forward "^\\*\\*\\* " nil t))
(setq patch-end (match-beginning 0)))
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
(save-restriction
(narrow-to-region patch-start patch-end)
emacs: show: handle inline patch fake parts at top level The inline patch fake part handler also modifies the content-type so handle this in notmuch-show-insert-bodypart too.
2013-05-04 15:01:15 +02:00
(setq part (plist-put part :content-type "inline patch"))
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
(setq part (plist-put part :content (buffer-string)))
(setq part (plist-put part :id -1))
(setq part (plist-put part :filename
(notmuch-wash-subject-to-patch-filename
(plist-get
(plist-get msg :headers) :Subject))))
(delete-region (point-min) (point-max))
(notmuch-show-insert-bodypart nil part depth)))))
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
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/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
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
(provide 'notmuch-wash)
emacs: Fix packaging Refer to (info "(elisp) Library Headers") for package conventions.
2016-04-13 09:58:47 +02:00
;;; notmuch-wash.el ends here
Reference in a new issue Copy permalink