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

996 lines
37 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-hello.el --- welcome to notmuch, a frontend -*- lexical-binding: t -*-
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;;
;; Copyright © David Edmondson
;;
;; 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: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;;
;; Authors: 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 notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
(require 'widget)
(require 'wid-edit) ; For `widget-forward'.
(require 'notmuch-lib)
emacs: Re-arrange message sending code Define a new `mail-user-agent' (`notmuch-user-agent') and use it by default. Re-arrange various routines that send mail to use this (compose, reply, forward). Insert a `User-Agent:' header by default. This is the real commit for this functionality this time. The previous attempt to merge this code: commit 57926bc7b0f784cbacb620fda0ee5157e2e0ff27 was botched (by Carl Worth, not David) to include only the Makefile change. So the build was broken until this commit that actually adds the new file.
2010-04-22 11:03:32 +02:00
(require 'notmuch-mua)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(declare-function notmuch-search "notmuch"
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
(&optional query oldest-first target-thread target-line
no-display))
(declare-function notmuch-poll "notmuch-lib" ())
emacs: allow saved searches to select tree-view This patch allows the user to customize a saved search to choose tree view rather than the default search view. It also updates notmuch-jump so that it respects this choice.
2015-10-14 10:38:22 +02:00
(declare-function notmuch-tree "notmuch-tree"
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
(&optional query query-context target buffer-name
open-target unthreaded parent-buffer))
(declare-function notmuch-unthreaded "notmuch-tree"
(&optional query query-context target buffer-name
open-target))
notmuch-hello/jump: allow saved searches to specify unthreaded mode Saved searches in notmuch-hello and notmuch-jump can specify whether to use search mode or tree mode. This adds an option for them to specify unthreaded mode.
2020-02-27 18:16:52 +01:00
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +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: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
(defun notmuch-saved-search-get (saved-search field)
"Get FIELD from SAVED-SEARCH.
If SAVED-SEARCH is a plist, this is just `plist-get', but for
backwards compatibility, this also deals with the two other
possible formats for SAVED-SEARCH: cons cells (NAME . QUERY) and
lists (NAME QUERY COUNT-QUERY)."
(cond
((keywordp (car saved-search))
(plist-get saved-search field))
;; It is not a plist so it is an old-style entry.
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
((consp (cdr saved-search))
(pcase-let ((`(,name ,query ,count-query) saved-search))
(cl-case field
(:name name)
(:query query)
(:count-query count-query)
(t nil))))
(t
(pcase-let ((`(,name . ,query) saved-search))
(cl-case field
(:name name)
(:query query)
(t nil))))))
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
(defun notmuch-hello-saved-search-to-plist (saved-search)
"Return a copy of SAVED-SEARCH in plist form.
If saved search is a plist then just return a copy. In other
cases, for backwards compatibility, convert to plist form and
return that."
(if (keywordp (car saved-search))
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
(copy-sequence saved-search)
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
(let ((fields (list :name :query :count-query))
plist-search)
(dolist (field fields plist-search)
(let ((string (notmuch-saved-search-get saved-search field)))
(when string
(setq plist-search (append plist-search (list field string)))))))))
(defun notmuch-hello--saved-searches-to-plist (symbol)
"Extract a saved-search variable into plist form.
The new style saved search is just a plist, but for backwards
compatibility we use this function to extract old style saved
searches so they still work in customize."
(let ((saved-searches (default-value symbol)))
(mapcar #'notmuch-hello-saved-search-to-plist saved-searches)))
(define-widget 'notmuch-saved-search-plist 'list
"A single saved search property list."
:tag "Saved Search"
:args '((list :inline t
:format "%v"
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(group :format "%v" :inline t
(const :format " Name: " :name)
(string :format "%v"))
(group :format "%v" :inline t
(const :format " Query: " :query)
(string :format "%v")))
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
(checklist :inline t
:format "%v"
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(group :format "%v" :inline t
(const :format "Shortcut key: " :key)
(key-sequence :format "%v"))
(group :format "%v" :inline t
(const :format "Count-Query: " :count-query)
(string :format "%v"))
(group :format "%v" :inline t
(const :format "" :sort-order)
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
(choice :tag " Sort Order"
(const :tag "Default" nil)
(const :tag "Oldest-first" oldest-first)
emacs: allow saved searches to select tree-view This patch allows the user to customize a saved search to choose tree view rather than the default search view. It also updates notmuch-jump so that it respects this choice.
2015-10-14 10:38:22 +02:00
(const :tag "Newest-first" newest-first)))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(group :format "%v" :inline t
(const :format "" :search-type)
emacs: allow saved searches to select tree-view This patch allows the user to customize a saved search to choose tree view rather than the default search view. It also updates notmuch-jump so that it respects this choice.
2015-10-14 10:38:22 +02:00
(choice :tag " Search Type"
(const :tag "Search mode" nil)
notmuch-hello/jump: allow saved searches to specify unthreaded mode Saved searches in notmuch-hello and notmuch-jump can specify whether to use search mode or tree mode. This adds an option for them to specify unthreaded mode.
2020-02-27 18:16:52 +01:00
(const :tag "Tree mode" tree)
(const :tag "Unthreaded mode" unthreaded))))))
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
emacs: Expand default saved searches and add shortcut keys This should help new users off to a better start with the addition of more sensible saved searches and default shortcut keys. Most existing users have probably customized this variable and won't be affected.
2014-08-05 03:45:21 +02:00
(defcustom notmuch-saved-searches
`((:name "inbox" :query "tag:inbox" :key ,(kbd "i"))
(:name "unread" :query "tag:unread" :key ,(kbd "u"))
(:name "flagged" :query "tag:flagged" :key ,(kbd "f"))
(:name "sent" :query "tag:sent" :key ,(kbd "t"))
(:name "drafts" :query "tag:draft" :key ,(kbd "d"))
(:name "all mail" :query "*" :key ,(kbd "a")))
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
"A list of saved searches to display.
The saved search can be given in 3 forms. The preferred way is as
a plist. Supported properties are
:name Name of the search (required).
:query Search to run (required).
emacs: Introduce notmuch-jump: shortcut keys to saved searches This introduces notmuch-jump, which is like a user-friendly, user-configurable global prefix map for saved searches. This provides a non-modal and much faster way to access saved searches than notmuch-hello. A user configures shortcut keys in notmuch-saved-searches, which are immediately accessible from anywhere in Notmuch under the "j" key (for "jump"). When the user hits "j", the minibuffer immediately shows a helpful table of bindings reminiscent of a completions buffer. This code is a combination of work from myself (originally, "notmuch-go"), David Edmondson, and modifications from Mark Walters.
2014-08-05 03:45:20 +02:00
:key Optional shortcut key for `notmuch-jump-search'.
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
:count-query Optional extra query to generate the count
shown. If not present then the :query property
is used.
:sort-order Specify the sort order to be used for the search.
emacs: always use elisp quoting style in doc-strings Emacs doc-strings use neither markdown nor lisp symbol quoting.
2020-11-16 22:28:30 +01:00
Possible values are `oldest-first', `newest-first'
or nil. Nil means use the default sort order.
notmuch-hello/jump: allow saved searches to specify unthreaded mode Saved searches in notmuch-hello and notmuch-jump can specify whether to use search mode or tree mode. This adds an option for them to specify unthreaded mode.
2020-02-27 18:16:52 +01:00
:search-type Specify whether to run the search in search-mode,
tree mode or unthreaded mode. Set to 'tree to specify tree
mode, 'unthreaded to specify unthreaded mode, and set to nil
(or anything except tree and unthreaded) to specify search mode.
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
Other accepted forms are a cons cell of the form (NAME . QUERY)
or a list of the form (NAME QUERY COUNT-QUERY)."
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
;; The saved-search format is also used by the all-tags notmuch-hello
;; section. This section generates its own saved-search list in one of
;; the latter two forms.
emacs: hello: bugfix for saved searches defcustom The recent changes for saved searches introduced a bug when notmuch was loaded after the saved search was defined. This was caused by a utility function not being defined when the defcustom was loaded. Fix this by moving some code around: the defcustom is moved into notmuch-hello (which is a more natural place anyway), and the utility functions are moved before the defcustom in notmuch-hello. We are rather constrained as the defcustom for saved searches is the first variable in the notmuch-hello customize window; to avoid moving this customize the defcustom needs to be the first defcustom in notmuch-hello, and the utility functions come before that. This patch also renames one of the utility functions from notmuch--saved-searches-to-plist to notmuch-hello--saved-searches-to-plist (as it is purely local to notmuch-hello) and corrects a couple of typo/spelling mistakes pointed out by Tomi.
2014-04-16 23:21:53 +02:00
:get 'notmuch-hello--saved-searches-to-plist
:type '(repeat notmuch-saved-search-plist)
:tag "List of Saved Searches"
:group 'notmuch-hello)
emacs: use a single history for all searches There are two ways to do search in Emacs UI: search widget in notmuch-hello buffer and `notmuch-search' function bound to "s". Before the change, these search mechanisms used different history lists. The patch makes notmuch-hello search use the same history list as `notmuch-search' function.
2012-01-25 02:10:53 +01:00
(defcustom notmuch-hello-recent-searches-max 10
"The number of recent searches to display."
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
:type 'integer
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-hello)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
(defcustom notmuch-show-empty-saved-searches nil
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
"Should saved searches with no messages be listed?"
:type 'boolean
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-hello)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: hello: bugfix: make alphabetically sorted saved searches work My recent changes to the saved search format broke the alphabetically sorted saved sort option. This makes it work again. Also update docs for saved-search sort defcustom to match the new format. Finally, since the saved-search list is no longer an alist change the names in the sort function to avoid confusion.
2014-04-12 14:46:26 +02:00
(defun notmuch-sort-saved-searches (saved-searches)
"Generate an alphabetically sorted saved searches list."
(sort (copy-sequence saved-searches)
(lambda (a b)
(string< (notmuch-saved-search-get a :name)
(notmuch-saved-search-get b :name)))))
emacs: Add new customization option to sort saved searches Add new customization option notmuch-saved-search-sort-function to sort saved searches in user-defined order. Provide a sort function to sort the saved searches in alphabetical order. Setting the search function to nil causes the saved searches not to be sorted, as before. This also remains the default. The function only affects display of the saved searches, not the order in which they are stored by custom. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-09-23 20:57:37 +02:00
(defcustom notmuch-saved-search-sort-function nil
"Function used to sort the saved searches for the notmuch-hello view.
This variable controls how saved searches should be sorted. No
sorting (nil) displays the saved searches in the order they are
stored in `notmuch-saved-searches'. Sort alphabetically sorts the
saved searches in alphabetical order. Custom sort function should
be a function or a lambda expression that takes the saved
emacs: hello: bugfix: make alphabetically sorted saved searches work My recent changes to the saved search format broke the alphabetically sorted saved sort option. This makes it work again. Also update docs for saved-search sort defcustom to match the new format. Finally, since the saved-search list is no longer an alist change the names in the sort function to avoid confusion.
2014-04-12 14:46:26 +02:00
searches list as a parameter, and returns a new saved searches
list to be used. For compatibility with the various saved-search
formats it should use notmuch-saved-search-get to access the
fields of the search."
emacs: Add new customization option to sort saved searches Add new customization option notmuch-saved-search-sort-function to sort saved searches in user-defined order. Provide a sort function to sort the saved searches in alphabetical order. Setting the search function to nil causes the saved searches not to be sorted, as before. This also remains the default. The function only affects display of the saved searches, not the order in which they are stored by custom. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-09-23 20:57:37 +02:00
:type '(choice (const :tag "No sorting" nil)
(const :tag "Sort alphabetically" notmuch-sort-saved-searches)
(function :tag "Custom sort function"
:value notmuch-sort-saved-searches))
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-hello)
emacs: Add new customization option to sort saved searches Add new customization option notmuch-saved-search-sort-function to sort saved searches in user-defined order. Provide a sort function to sort the saved searches in alphabetical order. Setting the search function to nil causes the saved searches not to be sorted, as before. This also remains the default. The function only affects display of the saved searches, not the order in which they are stored by custom. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-09-23 20:57:37 +02:00
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
(defvar notmuch-hello-indent 4
"How much to indent non-headers.")
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +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
(defimage notmuch-hello-logo ((:type png :file "notmuch-logo.png")))
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
(defcustom notmuch-show-logo t
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
"Should the notmuch logo be shown?"
:type 'boolean
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-hello)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
(defcustom notmuch-show-all-tags-list nil
emacs: notmuch-hello: Make viewing of all tags conditional. And off by default. There's a notmuch-hello-show-tags option in customize to toggle the default setting, as well as buttons to persistently toggle the visibility for the current session. I have enough tags in my database that it's quite a bit faster for notmuch-hello to come up without showing the tags.
2010-04-27 05:06:50 +02:00
"Should all tags be shown in the notmuch-hello view?"
:type 'boolean
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-hello)
emacs: notmuch-hello: Make viewing of all tags conditional. And off by default. There's a notmuch-hello-show-tags option in customize to toggle the default setting, as well as buttons to persistently toggle the visibility for the current session. I have enough tags in my database that it's quite a bit faster for notmuch-hello to come up without showing the tags.
2010-04-27 05:06:50 +02:00
emacs: Make the queries used in the all-tags section configurable This patch adds a customization variable that controls what queries are used to construct the all-tags section in notmuch-hello. It allows the user to specify a function to construct the query given a tag or a string that is used as a filter for each tag. It also adds a variable to hide various tags from the all-tags section. Signed-off-by: Daniel Schoepe <daniel.schoepe@googlemail.com>
2011-05-25 23:21:54 +02:00
(defcustom notmuch-hello-tag-list-make-query nil
"Function or string to generate queries for the all tags list.
This variable controls which query results are shown for each tag
in the \"all tags\" list. If nil, it will use all messages with
that tag. If this is set to a string, it is used as a filter for
messages having that tag (equivalent to \"tag:TAG and (THIS-VARIABLE)\").
Finally this can be a function that will be called for each tag and
should return a filter for that tag, or nil to hide the tag."
:type '(choice (const :tag "All messages" nil)
(const :tag "Unread messages" "tag:unread")
emacs: Fix notmuch-hello-tag-list-make-query defcustom It was not possible to define custom filters or filter functions because the types were const. Remove const to allow editing. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-12-20 20:53:13 +01:00
(string :tag "Custom filter"
:value "tag:unread")
(function :tag "Custom filter function"))
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-hello)
emacs: Make the queries used in the all-tags section configurable This patch adds a customization variable that controls what queries are used to construct the all-tags section in notmuch-hello. It allows the user to specify a function to construct the query given a tag or a string that is used as a filter for each tag. It also adds a variable to hide various tags from the all-tags section. Signed-off-by: Daniel Schoepe <daniel.schoepe@googlemail.com>
2011-05-25 23:21:54 +02:00
(defcustom notmuch-hello-hide-tags nil
"List of tags to be hidden in the \"all tags\"-section."
:type '(repeat string)
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-hello)
emacs: Make the queries used in the all-tags section configurable This patch adds a customization variable that controls what queries are used to construct the all-tags section in notmuch-hello. It allows the user to specify a function to construct the query given a tag or a string that is used as a filter for each tag. It also adds a variable to hide various tags from the all-tags section. Signed-off-by: Daniel Schoepe <daniel.schoepe@googlemail.com>
2011-05-25 23:21:54 +02:00
emacs: Adapt the logo background colour to that of the frame The notmuch logo uses transparency. That can display poorly when inserting the image into an emacs buffer (black logo on a black background), so force the background colour of the image. We use a face (`notmuch-hello-logo-background') to represent the colour so that `defface' can be used to declare the different possible colours, which depend on whether the frame has a light or dark background.
2010-04-26 11:25:28 +02:00
(defface notmuch-hello-logo-background
'((((class color)
(background dark))
(:background "#5f5f5f"))
(((class color)
(background light))
(:background "white")))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
"Background colour for the notmuch logo."
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-hello
:group 'notmuch-faces)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
(defcustom notmuch-column-control t
"Controls the number of columns for saved searches/tags in notmuch view.
This variable has three potential sets of values:
- t: automatically calculate the number of columns possible based
on the tags to be shown and the window width,
- an integer: a lower bound on the number of characters that will
be used to display each column,
- a float: a fraction of the window width that is the lower bound
on the number of characters that should be used for each
column.
So:
- if you would like two columns of tags, set this to 0.5.
- if you would like a single column of tags, set this to 1.0.
- if you would like tags to be 30 characters wide, set this to
30.
- if you don't want to worry about all of this nonsense, leave
this set to `t'."
:type '(choice
(const :tag "Automatically calculated" t)
(integer :tag "Number of characters")
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
(float :tag "Fraction of window"))
:group 'notmuch-hello)
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
emacs: Change the default thousands separator to a space This had been discussed and decided on IRC. Rationale: Therefore the space is recommended in the SI/ISO 31-0 standard, and the International Bureau of Weights and Measures states that "for numbers with many digits the digits may be divided into groups of three by a thin space, in order to facilitate reading. Neither dots nor commas are inserted in the spaces between groups of three". (http://en.wikipedia.org/wiki/Decimal_separator#Digit_grouping)
2011-12-21 14:44:19 +01:00
(defcustom notmuch-hello-thousands-separator " "
emacs: rename notmuch-decimal-separator to notmuch-hello-thousands-separator In 123,456.78, "." is the decimal separator, but "," is the thousands separator.
2011-12-21 14:44:18 +01:00
"The string used as a thousands separator.
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
emacs: Change the default thousands separator to a space This had been discussed and decided on IRC. Rationale: Therefore the space is recommended in the SI/ISO 31-0 standard, and the International Bureau of Weights and Measures states that "for numbers with many digits the digits may be divided into groups of three by a thin space, in order to facilitate reading. Neither dots nor commas are inserted in the spaces between groups of three". (http://en.wikipedia.org/wiki/Decimal_separator#Digit_grouping)
2011-12-21 14:44:19 +01:00
Typically \",\" in the US and UK and \".\" or \" \" in Europe.
The latter is recommended in the SI/ISO 31-0 standard and by the
International Bureau of Weights and Measures."
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 'string
:group 'notmuch-hello)
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
emacs: Add notmuch-hello-mode-hook Functions called after entering `notmuch-hello-mode'
2011-10-29 18:35:04 +02:00
(defcustom notmuch-hello-mode-hook nil
"Functions called after entering `notmuch-hello-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
:type 'hook
:group 'notmuch-hello
:group 'notmuch-hooks)
emacs: Add notmuch-hello-mode-hook Functions called after entering `notmuch-hello-mode'
2011-10-29 18:35:04 +02:00
emacs: add notmuch-hello-refresh-hook This hook is called every time a notmuch-hello buffer is updated.
2011-12-21 02:28:14 +01:00
(defcustom notmuch-hello-refresh-hook nil
"Functions called after updating a `notmuch-hello' buffer."
:type 'hook
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-hello
:group 'notmuch-hooks)
emacs: add notmuch-hello-refresh-hook This hook is called every time a notmuch-hello buffer is updated.
2011-12-21 02:28:14 +01:00
emacs: define notmuch-hello-url as a constant
2020-11-16 22:28:26 +01:00
(defconst notmuch-hello-url "https://notmuchmail.org"
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
"The `notmuch' web site.")
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defvar notmuch-hello-custom-section-options
'((:filter (string :tag "Filter for each tag"))
(:filter-count (string :tag "Different filter to generate message counts"))
(:initially-hidden (const :tag "Hide this section on startup" t))
(:show-empty-searches (const :tag "Show queries with no matching messages" t))
(:hide-if-empty (const :tag "Hide this section if all queries are empty
\(and not shown by show-empty-searches)" t)))
"Various customization-options for notmuch-hello-tags/query-section.")
(define-widget 'notmuch-hello-tags-section 'lazy
"Customize-type for notmuch-hello tag-list sections."
:tag "Customized tag-list section (see docstring for details)"
:type
`(list :tag ""
(const :tag "" notmuch-hello-insert-tags-section)
(string :tag "Title for this section")
(plist
:inline t
:options
,(append notmuch-hello-custom-section-options
'((:hide-tags (repeat :tag "Tags that will be hidden"
string)))))))
(define-widget 'notmuch-hello-query-section 'lazy
"Customize-type for custom saved-search-like sections"
:tag "Customized queries section (see docstring for details)"
:type
`(list :tag ""
emacs: fix custom queries section customization widget in notmuch-hello The customization widget referred to a non-existing function `notmuch-hello-insert-query-list'. The patch changes it to the correct one - `notmuch-hello-insert-searches'. The relevant test is fixed now.
2012-05-05 16:39:47 +02:00
(const :tag "" notmuch-hello-insert-searches)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(string :tag "Title for this section")
(repeat :tag "Queries"
(cons (string :tag "Name") (string :tag "Query")))
(plist :inline t :options ,notmuch-hello-custom-section-options)))
(defcustom notmuch-hello-sections
(list #'notmuch-hello-insert-header
#'notmuch-hello-insert-saved-searches
#'notmuch-hello-insert-search
#'notmuch-hello-insert-recent-searches
#'notmuch-hello-insert-alltags
#'notmuch-hello-insert-footer)
"Sections for notmuch-hello.
The list contains functions which are used to construct sections in
notmuch-hello buffer. When notmuch-hello buffer is constructed,
these functions are run in the order they appear in this list. Each
function produces a section simply by adding content to the current
buffer. A section should not end with an empty line, because a
newline will be inserted after each section by `notmuch-hello'.
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
Each function should take no arguments. The return value is
ignored.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
For convenience an element can also be a list of the form (FUNC ARG1
ARG2 .. ARGN) in which case FUNC will be applied to the rest of the
list.
A \"Customized tag-list section\" item in the customize-interface
displays a list of all tags, optionally hiding some of them. It
is also possible to filter the list of messages matching each tag
by an additional filter query. Similarly, the count of messages
displayed next to the buttons can be generated by applying a
different filter to the tag query. These filters are also
supported for \"Customized queries section\" items."
emacs: Put notmuch-hello-sections in custom group notmuch-hello
2012-04-16 04:57:36 +02:00
:group 'notmuch-hello
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
:type
'(repeat
(choice (function-item notmuch-hello-insert-header)
(function-item notmuch-hello-insert-saved-searches)
(function-item notmuch-hello-insert-search)
(function-item notmuch-hello-insert-recent-searches)
(function-item notmuch-hello-insert-alltags)
(function-item notmuch-hello-insert-footer)
(function-item notmuch-hello-insert-inbox)
notmuch-hello-tags-section
notmuch-hello-query-section
(function :tag "Custom section"))))
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
(defcustom notmuch-hello-auto-refresh t
"Automatically refresh when returning to the notmuch-hello buffer."
:group 'notmuch-hello
:type 'boolean)
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
;;; Internal variables
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defvar notmuch-hello-hidden-sections 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
"List of sections titles whose contents are hidden.")
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defvar notmuch-hello-first-run t
emacs: place complete first sentence on first doc-string line
2020-11-16 22:28:29 +01:00
"True if `notmuch-hello' is run for the first time, set to nil afterwards.")
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +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
;;; Widgets for inserters
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
emacs: define new notmuch-search-item widget type This is complex enough to warrant a dedicated widget type, which will make future improvements less messy to implement.
2021-01-10 15:00:39 +01:00
(define-widget 'notmuch-search-item 'item
"A recent search."
:format "%v\n"
:value-create 'notmuch-search-item-value-create)
(defun notmuch-search-item-value-create (widget)
(let ((value (widget-get widget :value)))
(widget-insert (make-string notmuch-hello-indent ?\s))
(widget-create 'editable-field
:size (widget-get widget :size)
:parent widget
:action #'notmuch-hello-search
value)
(widget-insert " ")
(widget-create 'push-button
:parent widget
:notify #'notmuch-hello-add-saved-search
"save")
(widget-insert " ")
(widget-create 'push-button
:parent widget
:notify #'notmuch-hello-delete-search-from-history
"del")))
(defun notmuch-search-item-field-width ()
(max 8 ; Don't let the search boxes be less than 8 characters wide.
(- (window-width)
notmuch-hello-indent ; space at bol
notmuch-hello-indent ; space at eol
1 ; for the space before the [save] button
6 ; for the [save] button
1 ; for the space before the [del] button
5))) ; for the [del] 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
;;; Widget actions
emacs: sanitize dedicated widget action/notify functions These functions are used as action/notify functions. That dictates the appropriate function signatures but even though these functions are not used for anything else they use incompatible signatures, forcing the callers to use lambda expressions to deal with these incompatibilities. Fix that by adjusting the function signatures to the needs of the only intended callers. Two of these functions were defined as commands but because the interactive form did not return the mandatory arguments, we know that nobody (successfully) used these as commands. In one case we move the location of a y-or-n-p prompt.
2021-01-10 15:00:38 +01:00
(defun notmuch-hello-search (widget &rest _event)
(let ((search (widget-value widget)))
(when search
(setq search (string-trim search))
(let ((history-delete-duplicates t))
(add-to-history 'notmuch-search-history search)))
(notmuch-search search notmuch-search-oldest-first)))
(defun notmuch-hello-add-saved-search (widget &rest _event)
(let ((search (widget-value (widget-get widget :parent)))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
(name (completing-read "Name for saved search: "
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
notmuch-saved-searches)))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;; If an existing saved search with this name exists, remove it.
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
(setq notmuch-saved-searches
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 elem in notmuch-saved-searches
emacs: various cosmetic improvements
2021-01-13 18:37:50 +01:00
unless (equal name (notmuch-saved-search-get elem :name))
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
collect elem))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;; Add the new one.
emacs: Remove "hello" from all variables exported through customize. We've recently changed things so that the notmuch-hello screen is the default view one gets by executing `notmuch'. So hide the "hello" name from everything exposed in the customize interface, (leaving "hello" as just an internal name within the implementation).
2010-04-27 06:45:19 +02:00
(customize-save-variable 'notmuch-saved-searches
emacs: Make saving new saved searches append, not prepend Append new saved searches at the end of saved searches rather than insert in front. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-09-23 20:57:38 +02:00
(add-to-list 'notmuch-saved-searches
emacs: hello: add a customize for saved-searches Make the defcustom for notmuch-saved-searches use the new plist format. It should still work with oldstyle saved-searches but will write the newstyle form.
2014-04-06 07:44:47 +02:00
(list :name name :query search) t))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
(message "Saved '%s' as '%s'." search name)
(notmuch-hello-update)))
emacs: sanitize dedicated widget action/notify functions These functions are used as action/notify functions. That dictates the appropriate function signatures but even though these functions are not used for anything else they use incompatible signatures, forcing the callers to use lambda expressions to deal with these incompatibilities. Fix that by adjusting the function signatures to the needs of the only intended callers. Two of these functions were defined as commands but because the interactive form did not return the mandatory arguments, we know that nobody (successfully) used these as commands. In one case we move the location of a y-or-n-p prompt.
2021-01-10 15:00:38 +01:00
(defun notmuch-hello-delete-search-from-history (widget &rest _event)
(when (y-or-n-p "Are you sure you want to delete this search? ")
(let ((search (widget-value (widget-get widget :parent))))
(setq notmuch-search-history
(delete search notmuch-search-history)))
emacs: hello: allow deleting individual searches in the history This commit adds an extra button at the end of the search entries that allows deleting that individual search from the history. A short confirmation («y» or «n») is made before taking action.
2013-06-07 22:57:46 +02:00
(notmuch-hello-update)))
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
;;; Button utilities
;; `notmuch-hello-query-counts', `notmuch-hello-nice-number' and
;; `notmuch-hello-insert-buttons' are used outside this section.
;; All other functions that are defined in this section are only
;; used by these two functions.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-longest-label (searches-alist)
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
(or (cl-loop for elem in searches-alist
maximize (length (notmuch-saved-search-get elem :name)))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
0))
emacs: Fix `notmuch-hello-insert-tags' to correctly draw the tags. The fix in 1e1871154341cdd3413fe3f32e3aae477826d815 broke end-of-row wrapping when drawing the table of tags/saved searches. Fix that and improve the readability of the matrix reflection code to hasten future debugging.
2010-04-27 12:04:37 +02:00
(defun notmuch-hello-reflect-generate-row (ncols nrows row list)
(let ((len (length list)))
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 col from 0 to (- ncols 1)
collect (let ((offset (+ (* nrows col) row)))
(if (< offset len)
(nth offset list)
;; Don't forget to insert an empty slot in the
;; output matrix if there is no corresponding
;; value in the input matrix.
nil)))))
emacs: Fix `notmuch-hello-insert-tags' to correctly draw the tags. The fix in 1e1871154341cdd3413fe3f32e3aae477826d815 broke end-of-row wrapping when drawing the table of tags/saved searches. Fix that and improve the readability of the matrix reflection code to hasten future debugging.
2010-04-27 12:04:37 +02:00
(defun notmuch-hello-reflect (list ncols)
"Reflect a `ncols' wide matrix represented by `list' along the
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
diagonal."
;; Not very lispy...
emacs: Remove notmuch-hello-roundup function as it does the same as (ceiling number divisor) which is already provided in elisp.
2010-04-30 12:33:57 +02:00
(let ((nrows (ceiling (length list) ncols)))
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 row from 0 to (- nrows 1)
append (notmuch-hello-reflect-generate-row ncols nrows row list))))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +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-hello-widget-search (widget &rest _ignore)
emacs: various cosmetic improvements
2021-01-13 18:37:50 +01:00
(cl-case (widget-get widget :notmuch-search-type)
(tree
(notmuch-tree (widget-get widget :notmuch-search-terms)))
(unthreaded
(notmuch-unthreaded (widget-get widget :notmuch-search-terms)))
notmuch-hello/jump: allow saved searches to specify unthreaded mode Saved searches in notmuch-hello and notmuch-jump can specify whether to use search mode or tree mode. This adds an option for them to specify unthreaded mode.
2020-02-27 18:16:52 +01:00
(t
emacs: various cosmetic improvements
2021-01-13 18:37:50 +01:00
(notmuch-search (widget-get widget :notmuch-search-terms)
(widget-get widget :notmuch-search-oldest-first)))))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: Fix notmuch-hello to use its own function for counting search results. Previously, this was calling into a notmuch-folder-count function. Only, everything related to notmuch-folder is about to go away, so lets have notmuch-hello define its own function (notmuch-saved-search-count) for this purpose.
2010-04-27 07:40:31 +02:00
(defun notmuch-saved-search-count (search)
(car (process-lines notmuch-command "count" search)))
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
(defun notmuch-hello-tags-per-line (widest)
"Determine how many tags to show per line and how wide they
should be. Returns a cons cell `(tags-per-line width)'."
(let ((tags-per-line
(cond
((integerp notmuch-column-control)
(max 1
(/ (- (window-width) notmuch-hello-indent)
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
;; Count is 9 wide (8 digits plus space), 1 for the space
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
;; after the name.
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
(+ 9 1 (max notmuch-column-control widest)))))
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
((floatp notmuch-column-control)
(let* ((available-width (- (window-width) notmuch-hello-indent))
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(proposed-width (max (* available-width notmuch-column-control)
widest)))
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
(floor available-width proposed-width)))
(t
(max 1
(/ (- (window-width) notmuch-hello-indent)
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
;; Count is 9 wide (8 digits plus space), 1 for the space
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
;; after the name.
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
(+ 9 1 widest)))))))
emacs: Fix notmuch-hello to not break when given a very narrow window. Simply ensure that some subtractions never result in a negative number, (since emacs complains when asked to create a string with a negative length).
2010-10-22 21:03:34 +02:00
(cons tags-per-line (/ (max 1
(- (window-width) notmuch-hello-indent
;; Count is 9 wide (8 digits plus
;; space), 1 for the space after the
;; name.
(* tags-per-line (+ 9 1))))
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
tags-per-line))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-filtered-query (query filter)
"Constructs a query to search all messages matching QUERY and FILTER.
If FILTER is a string, it is directly used in the returned query.
If FILTER is a function, it is called with QUERY as a parameter and
the string it returns is used as the query. If nil is returned,
the entry is hidden.
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
Otherwise, FILTER is ignored."
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(cond
((functionp filter) (funcall filter query))
((stringp filter)
(concat "(" query ") and (" filter ")"))
(t query)))
emacs: hello: use the saved-search helper functions This uses the helper functions: the saved searches format has not changed yet but backwards compatibility means everything still works.
2014-04-06 07:44:46 +02:00
(defun notmuch-hello-query-counts (query-list &rest options)
"Compute list of counts of matched messages from QUERY-LIST.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
emacs: hello: use the saved-search helper functions This uses the helper functions: the saved searches format has not changed yet but backwards compatibility means everything still works.
2014-04-06 07:44:46 +02:00
QUERY-LIST must be a list of saved-searches. Ideally each of
these is a plist but other options are available for backwards
compatibility: see `notmuch-saved-searches' for details.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
emacs: hello: switch notmuch-hello-insert-buttons to plists Switching notmuch-hello-insert-buttons to plists means we can easily pass extra options through to the buttons.
2014-04-06 07:44:48 +02:00
The result is a list of plists each of which includes the
properties :name NAME, :query QUERY and :count COUNT, together
with any properties in the original saved-search.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
The values :show-empty-searches, :filter and :filter-count from
options will be handled as specified for
`notmuch-hello-insert-searches'."
emacs: hello: use batch count This modifies notmuch hello to use the new count --batch functionality. It should give exactly the same results as before but under many conditions it should be much faster. In particular it is much faster for remote use. The code is a little ugly as it has to do some working out of the query when asking the query and some when dealing with the result. However, the code path is exactly the same in both local and remote use.
2013-03-31 11:46:03 +02:00
(with-temp-buffer
emacs: hello: use the saved-search helper functions This uses the helper functions: the saved searches format has not changed yet but backwards compatibility means everything still works.
2014-04-06 07:44:46 +02:00
(dolist (elem query-list nil)
(let ((count-query (or (notmuch-saved-search-get elem :count-query)
(notmuch-saved-search-get elem :query))))
emacs: hello: use batch count This modifies notmuch hello to use the new count --batch functionality. It should give exactly the same results as before but under many conditions it should be much faster. In particular it is much faster for remote use. The code is a little ugly as it has to do some working out of the query when asking the query and some when dealing with the result. However, the code path is exactly the same in both local and remote use.
2013-03-31 11:46:03 +02:00
(insert
emacs: remove newlines from input to notmuch count --batch Since a newline starts a new query in batch mode, this causes mysterious crashes in the emacs interface if saved searches contain newlines. See the discussion at id:87wqhcxb5j.fsf@maritornes.cs.unb.ca In general newlines seem to be just whitespace to the xapian query parser, so this should be mainly harmless.
2014-02-08 15:25:17 +01:00
(replace-regexp-in-string
"\n" " "
(notmuch-hello-filtered-query count-query
(or (plist-get options :filter-count)
(plist-get options :filter))))
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
"\n")))
emacs: hello: make --batch error gracefully Recently notmuch-hello was converted to use batch count. However, it seems that several people run different versions of notmuch-emacs and notmuch-cli so this batch makes emacs fail with an error message if --batch is not available in the CLI. Amended by: db
2013-07-05 00:18:19 +02:00
(unless (= (call-process-region (point-min) (point-max) notmuch-command
t t nil "count" "--batch") 0)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(notmuch-logged-error
"notmuch count --batch failed"
"Please check that the notmuch CLI is new enough to support `count
emacs: hello: make --batch error gracefully Recently notmuch-hello was converted to use batch count. However, it seems that several people run different versions of notmuch-emacs and notmuch-cli so this batch makes emacs fail with an error message if --batch is not available in the CLI. Amended by: db
2013-07-05 00:18:19 +02:00
--batch'. In general we recommend running matching versions of
the CLI and emacs interface."))
emacs: hello: use batch count This modifies notmuch hello to use the new count --batch functionality. It should give exactly the same results as before but under many conditions it should be much faster. In particular it is much faster for remote use. The code is a little ugly as it has to do some working out of the query when asking the query and some when dealing with the result. However, the code path is exactly the same in both local and remote use.
2013-03-31 11:46:03 +02:00
(goto-char (point-min))
emacs: remove unnecessary notmuch-remove-if-not We could just have switched to using `cl-remove-if-not' instead, but the two uses of the *remove-if-not function are pretty strange to begin with so we refactor to not use any such function at all.
2020-11-16 22:28:33 +01:00
(cl-mapcan
(lambda (elem)
(let* ((elem-plist (notmuch-hello-saved-search-to-plist elem))
(search-query (plist-get elem-plist :query))
(filtered-query (notmuch-hello-filtered-query
search-query (plist-get options :filter)))
(message-count (prog1 (read (current-buffer))
(forward-line 1))))
(when (and filtered-query (or (plist-get options :show-empty-searches)
(> message-count 0)))
(setq elem-plist (plist-put elem-plist :query filtered-query))
(list (plist-put elem-plist :count message-count)))))
query-list)))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +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
(defun notmuch-hello-nice-number (n)
(let (result)
(while (> n 0)
(push (% n 1000) result)
(setq n (/ n 1000)))
(setq result (or result '(0)))
(apply #'concat
(number-to-string (car result))
(mapcar (lambda (elem)
(format "%s%03d" notmuch-hello-thousands-separator elem))
(cdr result)))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-insert-buttons (searches)
"Insert buttons for SEARCHES.
emacs: hello: switch notmuch-hello-insert-buttons to plists Switching notmuch-hello-insert-buttons to plists means we can easily pass extra options through to the buttons.
2014-04-06 07:44:48 +02:00
SEARCHES must be a list of plists each of which should contain at
least the properties :name NAME :query QUERY and :count COUNT,
where QUERY is the query to start when the button for the
corresponding entry is activated, and COUNT should be the number
of messages matching the query. Such a plist can be computed
with `notmuch-hello-query-counts'."
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(let* ((widest (notmuch-hello-longest-label searches))
(tags-and-width (notmuch-hello-tags-per-line widest))
emacs: Allow tuning of the tag/saved search layout. Add `notmuch-column-control', which has three potential sets of values: - t: automatically calculate the number of columns per line based on the tags to be shown and the window width, - an integer: a lower bound on the number of characters that will be used to display each column, - a float: a fraction of the window width that is the lower bound on the number of characters that should be used for each column. So: - if you would like two columns of tags, set this to 0.5. - if you would like a single column of tags, set this to 1.0. - if you would like tags to be 30 characters wide, set this to 30. - if you don't want to worry about all of this nonsense, leave this set to `t'.
2010-04-29 10:28:23 +02:00
(tags-per-line (car tags-and-width))
emacs: get rid of trailing spaces in notmuch-hello view This patch removes trailing spaces in notmuch-hello view. A side effect of this change is that tag/query buttons no longer include a space at the end. This means that pressing RET when the point is at the first character after the tag/query button no longer works (note that this is the standard behavior for buttons). We may change this behavior in the future (without adding trailing spaces back) if people would find this change inconvenient.
2012-03-10 04:54:15 +01:00
(column-width (cdr tags-and-width))
(column-indent 0)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
(count 0)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(reordered-list (notmuch-hello-reflect searches tags-per-line))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;; Hack the display of the buttons used.
(widget-push-button-prefix "")
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
(widget-push-button-suffix ""))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;; dme: It feels as though there should be a better way to
;; implement this loop than using an incrementing counter.
emacs: Fix column alignment in `notmuch-hello-insert-tags' Re-working the saved search/tag insertion to buttonize only the name of the saved search/tag plus one space broke the calculation of how much filler is required to complete the column, resulting in lines wider than the window.
2010-04-27 09:00:44 +02:00
(mapc (lambda (elem)
;; (not elem) indicates an empty slot in the matrix.
(when elem
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (> column-indent 0)
(widget-insert (make-string column-indent ? )))
emacs: hello: switch notmuch-hello-insert-buttons to plists Switching notmuch-hello-insert-buttons to plists means we can easily pass extra options through to the buttons.
2014-04-06 07:44:48 +02:00
(let* ((name (plist-get elem :name))
(query (plist-get elem :query))
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
(oldest-first (cl-case (plist-get elem :sort-order)
emacs: Add a sort-order option to saved-searches This adds a sort-order option to saved-searches, stores it in the saved-search buttons (widgets), and uses the stored value when the button is pressed. Storing the sort-order in the widget was suggested by Jani in id:4c3876274126985683e888641b29cf18142a5eb8.1391771337.git.jani@nikula.org.
2014-04-06 07:44:49 +02:00
(newest-first nil)
(oldest-first t)
(otherwise notmuch-search-oldest-first)))
notmuch-hello/jump: allow saved searches to specify unthreaded mode Saved searches in notmuch-hello and notmuch-jump can specify whether to use search mode or tree mode. This adds an option for them to specify unthreaded mode.
2020-02-27 18:16:52 +01:00
(search-type (plist-get elem :search-type))
emacs: hello: switch notmuch-hello-insert-buttons to plists Switching notmuch-hello-insert-buttons to plists means we can easily pass extra options through to the buttons.
2014-04-06 07:44:48 +02:00
(msg-count (plist-get elem :count)))
emacs: Pretty print the numbers of matching messages. Insert a separator every three digits when outputting numbers. Allow the user to choose the separator by customizing `notmuch-decimal-separator'. Widen the space allocated for message counts accordingly.
2010-05-04 15:44:39 +02:00
(widget-insert (format "%8s "
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(notmuch-hello-nice-number msg-count)))
emacs: Fix column alignment in `notmuch-hello-insert-tags' Re-working the saved search/tag insertion to buttonize only the name of the saved search/tag plus one space broke the calculation of how much filler is required to complete the column, resulting in lines wider than the window.
2010-04-27 09:00:44 +02:00
(widget-create 'push-button
:notify #'notmuch-hello-widget-search
:notmuch-search-terms query
emacs: Add a sort-order option to saved-searches This adds a sort-order option to saved-searches, stores it in the saved-search buttons (widgets), and uses the stored value when the button is pressed. Storing the sort-order in the widget was suggested by Jani in id:4c3876274126985683e888641b29cf18142a5eb8.1391771337.git.jani@nikula.org.
2014-04-06 07:44:49 +02:00
:notmuch-search-oldest-first oldest-first
emacs: allow saved searches to select tree-view This patch allows the user to customize a saved search to choose tree view rather than the default search view. It also updates notmuch-jump so that it respects this choice.
2015-10-14 10:38:22 +02:00
:notmuch-search-type search-type
emacs: get rid of trailing spaces in notmuch-hello view This patch removes trailing spaces in notmuch-hello view. A side effect of this change is that tag/query buttons no longer include a space at the end. This means that pressing RET when the point is at the first character after the tag/query button no longer works (note that this is the standard behavior for buttons). We may change this behavior in the future (without adding trailing spaces back) if people would find this change inconvenient.
2012-03-10 04:54:15 +01:00
name)
(setq column-indent
(1+ (max 0 (- column-width (length name)))))))
emacs: Use cl-incf where appropriate It's shorter. That's it pretty much.
2020-08-08 13:50:03 +02:00
(cl-incf count)
emacs: get rid of trailing spaces in notmuch-hello view This patch removes trailing spaces in notmuch-hello view. A side effect of this change is that tag/query buttons no longer include a space at the end. This means that pressing RET when the point is at the first character after the tag/query button no longer works (note that this is the standard behavior for buttons). We may change this behavior in the future (without adding trailing spaces back) if people would find this change inconvenient.
2012-03-10 04:54:15 +01:00
(when (eq (% count tags-per-line) 0)
(setq column-indent 0)
(widget-insert "\n")))
emacs: Fix column alignment in `notmuch-hello-insert-tags' Re-working the saved search/tag insertion to buttonize only the name of the saved search/tag plus one space broke the calculation of how much filler is required to complete the column, resulting in lines wider than the window.
2010-04-27 09:00:44 +02:00
reordered-list)
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;; If the last line was not full (and hence did not include a
;; carriage return), insert one now.
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 (eq (% count tags-per-line) 0)
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
(widget-insert "\n"))))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +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: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
emacs: hello: stop update from forcing the buffer to be displayed Make the notmuch-hello refresh function (notmuch-hello-update) not force the buffer to be displayed. All the callers call it when the buffer is already displayed so it will only affect non-interactive callers. Since it is just a trivial wrapper of notmuch-hello anyone who wants to force the buffer to be displayed should just call notmuch-hello.
2016-10-15 09:32:41 +02:00
(defun notmuch-hello-update ()
"Update the notmuch-hello buffer."
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
;; Lazy - rebuild everything.
emacs: make the refresh functions more consistent The different refreshed functions were called differently: some were called interactively and some were not. Make them all interactive.
2016-10-15 09:32:40 +02:00
(interactive)
emacs: hello: stop update from forcing the buffer to be displayed Make the notmuch-hello refresh function (notmuch-hello-update) not force the buffer to be displayed. All the callers call it when the buffer is already displayed so it will only affect non-interactive callers. Since it is just a trivial wrapper of notmuch-hello anyone who wants to force the buffer to be displayed should just call notmuch-hello.
2016-10-15 09:32:41 +02:00
(notmuch-hello t))
emacs: Make update of notmuch-hello leave point on the same widget. Before refreshing, we check which widget we are currently on, (or look for the next widget), and then we watch for that same widget to go by when constructing the buffer contents. Finally, we jump to the position we saw when the widget went by.
2010-04-27 02:59:01 +02:00
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
(defun notmuch-hello-window-configuration-change ()
"Hook function to update the hello buffer when it is switched to."
(let ((hello-buf (get-buffer "*notmuch-hello*"))
(do-refresh nil))
;; Consider all windows in the currently selected frame, since
;; that's where the configuration change happened. This also
;; refreshes our snapshot of all windows, so we have to do this
;; even if we know we won't refresh (e.g., hello-buf is null).
(dolist (window (window-list))
(let ((last-buf (window-parameter window 'notmuch-hello-last-buffer))
(cur-buf (window-buffer window)))
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 (eq last-buf cur-buf)
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
;; This window changed or is new. Update recorded buffer
;; for next time.
(set-window-parameter window 'notmuch-hello-last-buffer cur-buf)
(when (and (eq cur-buf hello-buf) last-buf)
;; The user just switched to hello in this window (hello
;; is currently visible, was not visible on the last
;; configuration change, and this is not a new window)
(setq do-refresh t)))))
(when (and do-refresh notmuch-hello-auto-refresh)
;; Refresh hello as soon as we get back to redisplay. On Emacs
;; 24, we can't do it right here because something in this
;; hook's call stack overrides hello's point placement.
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
;; FIXME And on Emacs releases that we still support?
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
(run-at-time nil nil #'notmuch-hello t))
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 hello-buf
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
;; Clean up hook
(remove-hook 'window-configuration-change-hook
#'notmuch-hello-window-configuration-change))))
Make notmuch-hello a mode. This enables the nifty '?' key binding to work in notmuch-hello (although for some strange reasons I don't see any descriptions for specific key bindings yet. Not sure how that is supposed to work though. But this starts, runs and behaves identical to the existing code. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-05-03 12:29:32 +02:00
(defvar notmuch-hello-mode-map
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
;; Inherit both widget-keymap and notmuch-common-keymap. We have
;; to use make-sparse-keymap to force this to be a new keymap (so
;; that when we modify map it does not modify widget-keymap).
(let ((map (make-composed-keymap (list (make-sparse-keymap) widget-keymap))))
emacs: Define a common shared keymap for all of notmuch This defines a single, currently empty keymap that all other notmuch mode maps inherit from.
2013-09-03 23:45:24 +02:00
(set-keymap-parent map notmuch-common-keymap)
Make notmuch-hello a mode. This enables the nifty '?' key binding to work in notmuch-hello (although for some strange reasons I don't see any descriptions for specific key bindings yet. Not sure how that is supposed to work though. But this starts, runs and behaves identical to the existing code. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-05-03 12:29:32 +02:00
(define-key map (kbd "<C-tab>") 'widget-backward)
map)
"Keymap for \"notmuch hello\" buffers.")
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-hello-mode fundamental-mode "notmuch-hello"
emacs: Fix indentation
2020-08-08 13:49:38 +02:00
"Major mode for convenient notmuch navigation. This is your entry portal into notmuch.
Make notmuch-hello a mode. This enables the nifty '?' key binding to work in notmuch-hello (although for some strange reasons I don't see any descriptions for specific key bindings yet. Not sure how that is supposed to work though. But this starts, runs and behaves identical to the existing code. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-05-03 12:29:32 +02:00
emacs: hello: promote '?' as the universal help key Move the brief help text at the bottom of the hello screen to the notmuch-hello-mode help, and promote '?' as the universal help key across Notmuch. This unclutters the hello screen, and allows for a more verbose description in the mode help. Hopefully, this change is useful for both experienced and new users alike. While at it, improve the links to Notmuch and hello screen customization.
2016-03-13 13:27:17 +01:00
Saved searches are \"bookmarks\" for arbitrary queries. Hit RET
or click on a saved search to view matching threads. Edit saved
searches with the `edit' button. Type `\\[notmuch-jump-search]'
in any Notmuch screen for quick access to saved searches that
have shortcut keys.
Type new searches in the search box and hit RET to view matching
threads. Hit RET in a recent search box to re-submit a previous
search. Edit it first if you like. Save a recent search to saved
searches with the `save' button.
Hit `\\[notmuch-search]' or `\\[notmuch-tree]' in any Notmuch
screen to search for messages and view matching threads or
messages, respectively. Recent searches are available in the
minibuffer history.
Expand the all tags view with the `show' button (and collapse
again with the `hide' button). Hit RET or click on a tag name to
view matching threads.
Hit `\\[notmuch-refresh-this-buffer]' to refresh the screen and
`\\[notmuch-bury-or-kill-this-buffer]' to quit.
The screen may be customized via `\\[customize]'.
Make notmuch-hello a mode. This enables the nifty '?' key binding to work in notmuch-hello (although for some strange reasons I don't see any descriptions for specific key bindings yet. Not sure how that is supposed to work though. But this starts, runs and behaves identical to the existing code. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-05-03 12:29:32 +02:00
Complete list of currently available key bindings:
\\{notmuch-hello-mode-map}"
emacs: various comment improvements
2021-01-10 15:01:00 +01:00
(setq notmuch-buffer-refresh-function #'notmuch-hello-update))
Make notmuch-hello a mode. This enables the nifty '?' key binding to work in notmuch-hello (although for some strange reasons I don't see any descriptions for specific key bindings yet. Not sure how that is supposed to work though. But this starts, runs and behaves identical to the existing code. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-05-03 12:29:32 +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
;;; Inserters
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-generate-tag-alist (&optional hide-tags)
emacs: Make the queries used in the all-tags section configurable This patch adds a customization variable that controls what queries are used to construct the all-tags section in notmuch-hello. It allows the user to specify a function to construct the query given a tag or a string that is used as a filter for each tag. It also adds a variable to hide various tags from the all-tags section. Signed-off-by: Daniel Schoepe <daniel.schoepe@googlemail.com>
2011-05-25 23:21:54 +02:00
"Return an alist from tags to queries to display in the all-tags section."
emacs: remove unnecessary notmuch-remove-if-not We could just have switched to using `cl-remove-if-not' instead, but the two uses of the *remove-if-not function are pretty strange to begin with so we refactor to not use any such function at all.
2020-11-16 22:28:33 +01:00
(cl-mapcan (lambda (tag)
(and (not (member tag hide-tags))
(list (cons tag
(concat "tag:"
(notmuch-escape-boolean-term tag))))))
(process-lines notmuch-command "search" "--output=tags" "*")))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-insert-header ()
"Insert the default notmuch-hello header."
(when notmuch-show-logo
(let ((image notmuch-hello-logo))
;; The notmuch logo uses transparency. That can display poorly
;; when inserting the image into an emacs buffer (black logo on
;; a black background), so force the background colour of the
;; image. We use a face to represent the colour so that
;; `defface' can be used to declare the different possible
;; colours, which depend on whether the frame has a light or
;; dark background.
(setq image (cons 'image
(append (cdr image)
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(list :background
(face-background
'notmuch-hello-logo-background)))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(insert-image image))
(widget-insert " "))
(widget-insert "Welcome to ")
;; Hack the display of the links used.
(let ((widget-link-prefix "")
(widget-link-suffix ""))
(widget-create 'link
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
:notify (lambda (&rest _ignore)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(browse-url notmuch-hello-url))
:help-echo "Visit the notmuch website."
"notmuch")
(widget-insert ". ")
(widget-insert "You have ")
(widget-create 'link
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
:notify (lambda (&rest _ignore)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(notmuch-hello-update))
:help-echo "Refresh"
(notmuch-hello-nice-number
emacs: Shorten long lines
2020-08-08 13:49:36 +02:00
(string-to-number
(car (process-lines notmuch-command "count")))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(widget-insert " messages.\n")))
(defun notmuch-hello-insert-saved-searches ()
"Insert the saved-searches section."
(let ((searches (notmuch-hello-query-counts
(if notmuch-saved-search-sort-function
(funcall notmuch-saved-search-sort-function
notmuch-saved-searches)
notmuch-saved-searches)
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
:show-empty-searches notmuch-show-empty-saved-searches)))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(when searches
(widget-insert "Saved searches: ")
(widget-create 'push-button
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
:notify (lambda (&rest _ignore)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(customize-variable 'notmuch-saved-searches))
"edit")
(widget-insert "\n\n")
(let ((start (point)))
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
(notmuch-hello-insert-buttons searches)
(indent-rigidly start (point) notmuch-hello-indent)))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-insert-search ()
"Insert a search widget."
(widget-insert "Search: ")
(widget-create 'editable-field
;; Leave some space at the start and end of the
;; search boxes.
:size (max 8 (- (window-width) notmuch-hello-indent
(length "Search: ")))
emacs: sanitize dedicated widget action/notify functions These functions are used as action/notify functions. That dictates the appropriate function signatures but even though these functions are not used for anything else they use incompatible signatures, forcing the callers to use lambda expressions to deal with these incompatibilities. Fix that by adjusting the function signatures to the needs of the only intended callers. Two of these functions were defined as commands but because the interactive form did not return the mandatory arguments, we know that nobody (successfully) used these as commands. In one case we move the location of a y-or-n-p prompt.
2021-01-10 15:00:38 +01:00
:action #'notmuch-hello-search)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
;; Add an invisible dot to make `widget-end-of-line' ignore
;; trailing spaces in the search widget field. A dot is used
;; instead of a space to make `show-trailing-whitespace'
;; happy, i.e. avoid it marking the whole line as trailing
;; spaces.
emacs: various cosmetic improvements
2021-01-13 18:37:50 +01:00
(widget-insert (propertize "." 'invisible t))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(widget-insert "\n"))
(defun notmuch-hello-insert-recent-searches ()
"Insert recent searches."
(when notmuch-search-history
(widget-insert "Recent searches: ")
emacs: define new notmuch-search-item widget type This is complex enough to warrant a dedicated widget type, which will make future improvements less messy to implement.
2021-01-10 15:00:39 +01:00
(widget-create
'push-button
:notify (lambda (&rest _ignore)
(when (y-or-n-p "Are you sure you want to clear the searches? ")
(setq notmuch-search-history nil)
(notmuch-hello-update)))
"clear")
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(widget-insert "\n\n")
emacs: define new notmuch-search-item widget type This is complex enough to warrant a dedicated widget type, which will make future improvements less messy to implement.
2021-01-10 15:00:39 +01:00
(let ((width (notmuch-search-item-field-width)))
(dolist (search (seq-take notmuch-search-history
notmuch-hello-recent-searches-max))
(widget-create 'notmuch-search-item :value search :size width)))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
emacs: hello: use the saved-search helper functions This uses the helper functions: the saved searches format has not changed yet but backwards compatibility means everything still works.
2014-04-06 07:44:46 +02:00
(defun notmuch-hello-insert-searches (title query-list &rest options)
"Insert a section with TITLE showing a list of buttons made from QUERY-LIST.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
emacs: hello: use the saved-search helper functions This uses the helper functions: the saved searches format has not changed yet but backwards compatibility means everything still works.
2014-04-06 07:44:46 +02:00
QUERY-LIST should ideally be a plist but for backwards
compatibility other forms are also accepted (see
`notmuch-saved-searches' for details). The plist should
contain keys :name and :query; if :count-query is also present
then it specifies an alternate query to be used to generate the
count for the associated search.
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
Supports the following entries in OPTIONS as a plist:
:initially-hidden - if non-nil, section will be hidden on startup
:show-empty-searches - show buttons with no matching messages
:hide-if-empty - hide if no buttons would be shown
(only makes sense without :show-empty-searches)
:filter - This can be a function that takes the search query as its argument and
fix typos
2018-01-02 16:32:38 +01:00
returns a filter to be used in conjunction with the query for that search or nil
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
to hide the element. This can also be a string that is used as a combined with
each query using \"and\".
:filter-count - Separate filter to generate the count displayed each search. Accepts
the same values as :filter. If :filter and :filter-count are specified, this
will be used instead of :filter, not in conjunction with it."
(widget-insert title ": ")
emacs: Use 'when' instead of 'if' when there is no ELSE part
2020-08-08 13:49:43 +02:00
(when (and notmuch-hello-first-run (plist-get options :initially-hidden))
(add-to-list 'notmuch-hello-hidden-sections title))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(let ((is-hidden (member title notmuch-hello-hidden-sections))
(start (point)))
(if is-hidden
(widget-create 'push-button
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
:notify `(lambda (widget &rest _ignore)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(setq notmuch-hello-hidden-sections
(delete ,title notmuch-hello-hidden-sections))
(notmuch-hello-update))
"show")
(widget-create 'push-button
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
:notify `(lambda (widget &rest _ignore)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(add-to-list 'notmuch-hello-hidden-sections
,title)
(notmuch-hello-update))
"hide"))
(widget-insert "\n")
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 is-hidden
emacs: hello: use the saved-search helper functions This uses the helper functions: the saved searches format has not changed yet but backwards compatibility means everything still works.
2014-04-06 07:44:46 +02:00
(let ((searches (apply 'notmuch-hello-query-counts query-list options)))
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
(when (or (not (plist-get options :hide-if-empty))
searches)
(widget-insert "\n")
(notmuch-hello-insert-buttons searches)
(indent-rigidly start (point) notmuch-hello-indent))))))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(defun notmuch-hello-insert-tags-section (&optional title &rest options)
"Insert a section displaying all tags with message counts.
TITLE defaults to \"All tags\".
Allowed options are those accepted by `notmuch-hello-insert-searches' and the
following:
:hide-tags - List of tags that should be excluded."
(apply 'notmuch-hello-insert-searches
(or title "All tags")
(notmuch-hello-generate-tag-alist (plist-get options :hide-tags))
options))
(defun notmuch-hello-insert-inbox ()
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
"Show an entry for each saved search and inboxed messages for each tag."
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(notmuch-hello-insert-searches "What's in your inbox"
(append
emacs: drop support for deprecated notmuch-folders Remove notmuch-folders which has been deprecated since commit a4669217600e4536dc0c49f0255af5e2d9bc183f Author: Carl Worth <cworth@cworth.org> Date: Mon Apr 26 22:42:07 2010 -0700 emacs: Rip out all of the notmuch-folder code. This lets us simplify the notmuch-saved-searches code slightly.
2012-12-03 22:23:44 +01:00
notmuch-saved-searches
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(notmuch-hello-generate-tag-alist))
:filter "tag:inbox"))
(defun notmuch-hello-insert-alltags ()
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
"Insert a section displaying all tags and associated message counts."
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(notmuch-hello-insert-tags-section
nil
:initially-hidden (not notmuch-show-all-tags-list)
:hide-tags notmuch-hello-hide-tags
:filter notmuch-hello-tag-list-make-query))
(defun notmuch-hello-insert-footer ()
"Insert the notmuch-hello footer."
(let ((start (point)))
emacs: hello: promote '?' as the universal help key Move the brief help text at the bottom of the hello screen to the notmuch-hello-mode help, and promote '?' as the universal help key across Notmuch. This unclutters the hello screen, and allows for a more verbose description in the mode help. Hopefully, this change is useful for both experienced and new users alike. While at it, improve the links to Notmuch and hello screen customization.
2016-03-13 13:27:17 +01:00
(widget-insert "Hit `?' for context-sensitive help in any Notmuch screen.\n")
(widget-insert "Customize ")
(widget-create 'link
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
:notify (lambda (&rest _ignore)
emacs: hello: promote '?' as the universal help key Move the brief help text at the bottom of the hello screen to the notmuch-hello-mode help, and promote '?' as the universal help key across Notmuch. This unclutters the hello screen, and allows for a more verbose description in the mode help. Hopefully, this change is useful for both experienced and new users alike. While at it, improve the links to Notmuch and hello screen customization.
2016-03-13 13:27:17 +01:00
(customize-group 'notmuch))
:button-prefix "" :button-suffix ""
"Notmuch")
(widget-insert " or ")
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(widget-create 'link
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
:notify (lambda (&rest _ignore)
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(customize-variable 'notmuch-hello-sections))
:button-prefix "" :button-suffix ""
emacs: hello: promote '?' as the universal help key Move the brief help text at the bottom of the hello screen to the notmuch-hello-mode help, and promote '?' as the universal help key across Notmuch. This unclutters the hello screen, and allows for a more verbose description in the mode help. Hopefully, this change is useful for both experienced and new users alike. While at it, improve the links to Notmuch and hello screen customization.
2016-03-13 13:27:17 +01:00
"this page.")
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(let ((fill-column (- (window-width) notmuch-hello-indent)))
(center-region start (point)))))
emacs: Make the queries used in the all-tags section configurable This patch adds a customization variable that controls what queries are used to construct the all-tags section in notmuch-hello. It allows the user to specify a function to construct the query given a tag or a string that is used as a filter for each tag. It also adds a variable to hide various tags from the all-tags section. Signed-off-by: Daniel Schoepe <daniel.schoepe@googlemail.com>
2011-05-25 23:21:54 +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
;;; Hello!
emacs: Fix the autoload comments Remove them from non-top-level entry points, (such as the functions to set notmuch modes and the deprecated notmuch-folder function). And add one to the notmuch-hello function. Also, add missing documentation string to notmuch-hello.
2010-10-30 00:27:01 +02:00
;;;###autoload
notmuch-hello: Preserve current position when invoking notmuch-hello Previously, we preserved the current position only when returning to the notmuch-hello buffer or when refreshing it. Fix to also preserve the position when directly invoking notmuch-hello, (such as from a global keybinding).
2010-04-27 04:43:21 +02:00
(defun notmuch-hello (&optional no-display)
emacs: Fix the autoload comments Remove them from non-top-level entry points, (such as the functions to set notmuch modes and the deprecated notmuch-folder function). And add one to the notmuch-hello function. Also, add missing documentation string to notmuch-hello.
2010-10-30 00:27:01 +02:00
"Run notmuch and display saved searches, known tags, etc."
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
(interactive)
emacs: add notmuch-assert-cli-sane to notmuch-hello This is meant to be the friendly entrypoint, so let's do something better than the mangled output described in id:5228989D.8030607@fifthhorseman.net
2014-01-26 19:44:27 +01:00
(notmuch-assert-cli-sane)
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
;; This may cause a window configuration change, so if the
;; auto-refresh hook is already installed, avoid recursive refresh.
(let ((notmuch-hello-auto-refresh nil))
(if no-display
(set-buffer "*notmuch-hello*")
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 "*notmuch-hello*")))
emacs: Refresh hello whenever the user switches to the buffer Previously, we refreshed hello when the user quit a search that was started from hello. This is fine assuming purely stack-oriented buffer use, but is quite fragile and requires hacks to search. This replaces that logic with a new approach that refreshes hello whenever the user switches to the hello buffer, regardless of how this happens.
2013-09-03 23:45:18 +02:00
;; Install auto-refresh hook
(when notmuch-hello-auto-refresh
(add-hook 'window-configuration-change-hook
#'notmuch-hello-window-configuration-change))
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
(let ((target-line (line-number-at-pos))
(target-column (current-column))
emacs: do not call `notmuch-hello-mode' on update `notmuch-hello' should call `notmuch-hello-mode' function only when run for the first time. But before the change, `notmuch-hello' used `kill-all-local-variables' to remove editable widgets fields. This caused the major mode to be reset, and `notmuch-hello-mode' to be called every time. The patch manually deletes all editable widget fields and removes `kill-all-local-variables' call.
2011-12-18 01:21:21 +01:00
(inhibit-read-only t))
;; Delete all editable widget fields. Editable widget fields are
;; tracked in a buffer local variable `widget-field-list' (and
;; others). If we do `erase-buffer' without properly deleting the
;; widgets, some widget-related functions are confused later.
(mapc 'widget-delete widget-field-list)
(erase-buffer)
Make notmuch-hello a mode. This enables the nifty '?' key binding to work in notmuch-hello (although for some strange reasons I don't see any descriptions for specific key bindings yet. Not sure how that is supposed to work though. But this starts, runs and behaves identical to the existing code. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-05-03 12:29:32 +02:00
(unless (eq major-mode 'notmuch-hello-mode)
(notmuch-hello-mode))
notmuch-hello: Preserve current position when invoking notmuch-hello Previously, we preserved the current position only when returning to the notmuch-hello buffer or when refreshing it. Fix to also preserve the position when directly invoking notmuch-hello, (such as from a global keybinding).
2010-04-27 04:43:21 +02:00
(let ((all (overlay-lists)))
;; Delete all the overlays.
(mapc 'delete-overlay (car all))
(mapc 'delete-overlay (cdr all)))
emacs: simplify point placement in notmuch-hello refresh notmuch-hello (called also through notmuch-hello-update, bound to '=' by default) tries to find the widget under or following point before refresh, and put the point back to the widget afterwards. The code has grown quite complicated, and has at least the following issues: 1) All the individual section functions have to include code to support point placement. If there is no such support, point is dropped to the search box. Only saved searches and all tags sections support point placement. 2) Point placement is based on widget-value. If there are two widgets with the same widget-value (for example a saved search with the same name as a tag) the point is moved to the earlier one, even if point was on the later one. 3) When first entering notmuch-hello notmuch-hello-target is nil, and point is dropped to the search box. Moving the point to the search box is annoying because the user is required to move the point before being able to enter key bindings. Simplify the code by removing all point placement based on widgets, as it does not work properly, and trying to fix that would unnecessarily complicate the code. Save current line and column before refresh, and restore them afterwards. Sometimes, if notmuch-show-empty-saved-searches is nil, and the refresh adds or removes saved searches from the list, this has the appearance of moving the point relative to the nearest widgets. This is a much smaller and less frequent problem than the ones listed above.
2012-09-30 09:36:12 +02:00
(mapc
(lambda (section)
(let ((point-before (point)))
(if (functionp section)
(funcall section)
(apply (car section) (cdr section)))
;; don't insert a newline when the previous section didn't
;; show anything.
(unless (eq (point) point-before)
(widget-insert "\n"))))
notmuch-hello-sections)
(widget-setup)
;; Move point back to where it was before refresh. Use line and
;; column instead of point directly to be insensitive to additions
;; and removals of text within earlier lines.
(goto-char (point-min))
(forward-line (1- target-line))
(move-to-column target-column))
emacs: User-defined sections in notmuch-hello This patch makes the notmuch-hello screen fully customizable by allowing the user to add and remove arbitrary sections. It also provides some convenience functions for constructing sections, e.g. showing the unread message count for each tag. This is done by specifying a list of functions that will be run when notmuch-hello is invoked.
2012-02-17 15:48:07 +01:00
(run-hooks 'notmuch-hello-refresh-hook)
(setq notmuch-hello-first-run nil))
emacs: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +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: Add notmuch-hello.el, a friendly frontend to notmuch This is based on the prototype that Carl Worth described in the TODO file. It provides a search bar as well as support for recent searches, saved searches, and a list of all tags in the database (as well as the number of messages with each tag).
2010-04-22 10:27:33 +02:00
(provide 'notmuch-hello)
emacs: Fix packaging Refer to (info "(elisp) Library Headers") for package conventions.
2016-04-13 09:58:47 +02:00
;;; notmuch-hello.el ends here
Reference in a new issue Copy permalink