David Bremner [Wed, 17 Feb 2021 00:08:23 +0000 (20:08 -0400)]
lib/open: check for split configuration when creating database.
The main functionality will be tested when notmuch-new is converted to
support split configuration. Here only the somewhat odd case of split
mail root which is actually symlinked to the database path is tested.
David Bremner [Thu, 31 Dec 2020 22:20:31 +0000 (18:20 -0400)]
lib: support splitting mail from database location.
Introduce a new configuration value for the mail root, and use it to
locate mail messages in preference to the database.path (which
previously implied the mail messages were also in this location.
Initially only a subset of the CLI is tested in a split
configuration. Further changes will be needed for the remainder of the
CLI to work in split configurations.
David Bremner [Sun, 7 Feb 2021 16:54:45 +0000 (12:54 -0400)]
lib/open: Use check for existing database by trial opening
This is a bit heavyweight for now, but it will make more sense when we
check multiple locations for the Xapian database.
David Bremner [Sat, 30 Jan 2021 17:30:18 +0000 (13:30 -0400)]
lib/open: use _finish_open in n_d_create_with_config
This avoids reading the configuration file twice.
David Bremner [Sat, 30 Jan 2021 17:57:32 +0000 (13:57 -0400)]
lib/open: factor out the second half of n_d_open_with_config
The idea is to allow reuse in n_d_create_with_config. This is
primarily code movement, with some changes in error messages to reduce
the number of input parameters.
David Bremner [Thu, 4 Mar 2021 13:31:13 +0000 (09:31 -0400)]
lib/open: reuse directory checks from n_d_c_with_config
Make checks more uniform between creating new databases and opening
existing ones.
David Bremner [Fri, 29 Jan 2021 11:44:18 +0000 (07:44 -0400)]
lib/open: factor out library initialization
This is slightly more tidy, but more importantly it allows for re-use
of this code in n_d_create_with_config. That re-use will be crucial
when we no longer call n_d_open_with_config from
n_d_create_with_config.
David Bremner [Tue, 2 Feb 2021 20:43:58 +0000 (16:43 -0400)]
lib: remove "path" from notmuch struct
This removes duplication between the struct element and the
configuration string_map entry. Create a simple wrapper for setting
the database path that makes sure the trailing / is stripped.
David Bremner [Wed, 27 Jan 2021 00:46:44 +0000 (20:46 -0400)]
lib/open: allocate notmuch_t struct early
This gives more flexibility in restructuring the database opening
code.
David Bremner [Sat, 26 Dec 2020 03:22:23 +0000 (23:22 -0400)]
lib/open: support NOTMUCH_DATABASE environment variable
The additional code is trivial, but making sure we get the priority of
various options correct takes a few tests.
David Bremner [Sat, 6 Feb 2021 22:50:20 +0000 (18:50 -0400)]
CLI/show: complete conversion to new configuration framework.
In order to open the database in main() for this command, we may need
to re-open it in the (possibly less common) case where crypto options
require write access.
David Bremner [Fri, 19 Mar 2021 01:58:02 +0000 (22:58 -0300)]
CLI/new: drop the write lock to run the pre-new hook.
This fixes a bug reported in [1]. In principle it could be possible
avoid one of these reopens, but it complicates the logic in main with
respect to creating new databases.
[1]: id:
9C1993DF-84BD-4199-A9C8-
BADA98498812@bubblegen.co.uk
David Bremner [Fri, 19 Mar 2021 01:54:13 +0000 (22:54 -0300)]
test: Add tests for write access to database from hooks.
Recent changes to configuration handling meant the pre-new hook was
run while the database was open read only, limiting what could be done
in the hook. Add some known broken tests for this problem, as well as
a regression test for write access from the post-new hook.
David Bremner [Sun, 14 Mar 2021 14:01:59 +0000 (11:01 -0300)]
lib: support reopening databases for write access.
In the future Xapian will apparently support this more conveniently
for the cases other than READ_ONLY => READ_ONLY
Conceptually this function seems to fit better in lib/open.cc;
database.cc is still large enough that moving the function makes
sense.
David Bremner [Sun, 14 Mar 2021 14:01:58 +0000 (11:01 -0300)]
lib: save path of xapian database in notmuch struct.
This will allow re-opening in a different mode (read/write
vs. read-only) with current Xapian API. It will also prove useful when
updating the compact functions to support more flexible database
location.
David Bremner [Sun, 14 Mar 2021 14:01:57 +0000 (11:01 -0300)]
lib: publish API for notmuch_database_reopen
Include the (currently unused) mode argument which will specify which
mode to re-open the database in. Functionality and docs to be
finalized in a followup commit.
David Bremner [Sun, 14 Mar 2021 14:01:56 +0000 (11:01 -0300)]
test/setup: add check for config exists, but no database.
This code path is not currently tested, and will need updating if the
location of the xapian database changes.
David Bremner [Thu, 18 Mar 2021 01:20:35 +0000 (22:20 -0300)]
test: add known broken test for long directory bug
In [1] Gregor Zattler explained the results of his hard work
tracking down a bug in notmuch with long directories. This test
duplicates the bug.
[1]: id:
20210317194728.GB5561@no.workgroup
David Bremner [Sat, 6 Mar 2021 13:49:34 +0000 (09:49 -0400)]
lib/open: free GKeyFile
This fixes a small-to-medium (depending on size of config file) memory
leak.
David Bremner [Sat, 6 Mar 2021 13:49:33 +0000 (09:49 -0400)]
lib/config: free memory from traversing GKeyFile
This fixes a few small memory leaks.
David Bremner [Sat, 6 Mar 2021 13:49:32 +0000 (09:49 -0400)]
lib/open: free value from g_key_file_get_value
This fixes a small memory leak.
David Bremner [Sat, 6 Mar 2021 13:49:31 +0000 (09:49 -0400)]
lib/open: use local talloc context in n_d_create_with_config
This better matches the memory allocation semantics in
notmuch_database_open_with_config.
uncrustify [Sat, 13 Mar 2021 12:45:34 +0000 (08:45 -0400)]
cli: run uncrustify
This is the result of running
$ uncrustify --replace --config devel/uncrustify.cfg *.c *.h
in the top level source directory
Line breaks were then adjusted manually to keep argc and argv
together.
uncrustify [Sat, 13 Mar 2021 12:45:34 +0000 (08:45 -0400)]
test: run uncrustify
This is the result of running:
$ uncrustify --replace --config ../devel/uncrustify.cfg *.cc *.c *.h
in the test directory.
uncrustify [Sat, 13 Mar 2021 12:45:34 +0000 (08:45 -0400)]
util: run uncrustify
This is the result of running
$ uncrustify --replace --config ../devel/uncrustify.cfg *.c *.h
in the util directory
uncrustify [Sat, 13 Mar 2021 12:45:34 +0000 (08:45 -0400)]
lib: run uncrustify
This is the result of running
$ uncrustify --replace --config ../devel/uncrustify.cfg *.c *.h *.cc
in the lib directory
David Bremner [Sat, 16 Jan 2021 01:29:17 +0000 (21:29 -0400)]
test: clean up some extra whitespace.
The extra space is mainly just untidy.
Tomi Ollila [Thu, 25 Feb 2021 20:04:30 +0000 (22:04 +0200)]
test: T020-compact.sh: fix work directory location
Fix use of $TEST_DIRECTORY ($NOTMUCH_BUILDDIR/test/) with use of
$TMP_DIRECTORY ($NOTMUCH_BUILDDIR/test/tmp.T020-compact/ in case
of T020-compact.sh) as root directory where to write test files
and directories.
David Bremner [Sun, 7 Mar 2021 19:44:46 +0000 (15:44 -0400)]
devel/uncrustify: add line length limits.
A generous limit of 102 is chosen to moderate the amount of resulting
reformatting.
David Bremner [Thu, 18 Feb 2021 12:47:53 +0000 (08:47 -0400)]
Merge tag '0.31.4'
notmuch 0.31.4 release
David Bremner [Thu, 18 Feb 2021 11:53:00 +0000 (07:53 -0400)]
debian: drop patches
we should by synced up with the tarball again
David Bremner [Thu, 18 Feb 2021 11:52:39 +0000 (07:52 -0400)]
doc: bump copyright year
David Bremner [Thu, 18 Feb 2021 11:23:24 +0000 (07:23 -0400)]
debian: changelog for 0.31.4-1
David Bremner [Thu, 18 Feb 2021 11:21:48 +0000 (07:21 -0400)]
NEWS: news for 0.31.4
David Bremner [Thu, 18 Feb 2021 11:17:22 +0000 (07:17 -0400)]
version: update to 0.31.4
David Bremner [Mon, 15 Feb 2021 00:55:55 +0000 (20:55 -0400)]
test: Fix race condition in T568-lib-thread.sh
The assignment of thread-ids is (apparently) non-deterministic in a
way that mostly seems to show up on multicore machines. In my tests
the number is different from that previously assumed by this test
about 15% of the time on a 50 thread (25 core) Xeon.
Since message id's are fixed, use a message known to be in the thread
of interest to pick out the correct thread-id.
David Bremner [Mon, 15 Feb 2021 20:43:50 +0000 (16:43 -0400)]
fix build failure with glib 2.67
Based on a patch from Michael J Gruber [1]. As of glib 2.67 (more
specifically [2]), including "gmime-extra.h" inside an extern "C"
block causes build failures, because glib is using C++ features.
Observing that "gmime-extra.h" is no longer needed in
notmuch-private.h, which can simply delete that include, but
we have to correspondingly move the includes which might include
it (in particular crypto.h) out of the extern "C" block also.
This seems less fragile than only moving gmime-extra, and relying on
preprocessor sentinels to keep the deeper includes from happening.
Move to the include to the outside of the extern block.
[1]: id:
aee618a3d41f7889a7449aa16893e992325a909a.
1613055071.git.git@grubix.eu
[2]: https://gitlab.gnome.org/GNOME/glib/-/merge_requests/1715
Daniel Kahn Gillmor [Sat, 13 Feb 2021 00:26:22 +0000 (19:26 -0500)]
python: convert shebangs to python3
This is the last bit of "python" left in the notmuch codebase.
https://www.python.org/dev/peps/pep-0394/#recommendation encourages
"third-party distributors" to use more-specific shebang lines. I'm
not certain that the notmuch project itself is a "third-party
contributor" but I think this is a safe way to encourage people to use
python3 when they're developing notmuch.
We already have python3 explicitly elsewhere in the codebase for
developers (in nmbug).
Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
David Bremner [Mon, 15 Feb 2021 02:28:55 +0000 (22:28 -0400)]
lib: use a stricter unused macro
This would have caught bugs like the one corrected in the previous commit.
David Bremner [Mon, 15 Feb 2021 02:27:51 +0000 (22:27 -0400)]
lib/open: remove incorrect unused attribute
With the current unused macro in lib/notmuch-private.h this seems
harmless, but is misleading, since the parameter is in fact used.
David Bremner [Fri, 22 Jan 2021 11:34:51 +0000 (07:34 -0400)]
lib: add missing private status values.
Many public status values have been added without being copied to the
list of private status values.
David Bremner [Sun, 10 Jan 2021 15:54:35 +0000 (11:54 -0400)]
doc: describe new config framework
Remove STORED IN DATABASE discussion, describe search rules.
Currently profiles seem a bit pointless. They will make more sense
when they apply to databases as well.
David Bremner [Sun, 10 Jan 2021 11:50:14 +0000 (07:50 -0400)]
CLI: use configured hook directory
This enables support for hooks outside the database directory.
It relies strongly on configuration information being usable between
closing the database and destroying it.
David Bremner [Sat, 9 Jan 2021 19:05:58 +0000 (15:05 -0400)]
lib/open: set HOOK_DIR on open
This is a simple two step path search. Most error checking is
deferred until running the hooks.
David Bremner [Sat, 9 Jan 2021 13:19:50 +0000 (09:19 -0400)]
lib/config: add HOOK_DIR
The hook directory configuration needs to be kept in synch with the
other configuration information, so add scaffolding to support this at
database opening time.
David Bremner [Sat, 2 Jan 2021 17:10:39 +0000 (13:10 -0400)]
cli/new: convert to new config framework
In addition to the same type of changes as converting other
subcommands, add the possibility of creating a database at the top
level. It would probably make sense to use this for insert as well.
David Bremner [Sat, 2 Jan 2021 03:19:31 +0000 (23:19 -0400)]
cli/new: refactor database upgrade code
Move to a separate function. This is essentially just code movement.
David Bremner [Sat, 2 Jan 2021 00:43:14 +0000 (20:43 -0400)]
lib: introduce notmuch_database_create_with_config
This takes a config path parameter, and can use that to decide the
new database location.
David Bremner [Sun, 3 Jan 2021 12:50:12 +0000 (08:50 -0400)]
lib: add NOTMUCH_STATUS_DATABASE_EXISTS
It is desirable to distinguish between attempting to create a database
that already exists, and more fatal errors like permission problems.
David Bremner [Sat, 2 Jan 2021 00:22:00 +0000 (20:22 -0400)]
lib/database: move n_d_create* to open.cc
This will help share code with n_d_open_with_config.
David Bremner [Sun, 3 Jan 2021 12:30:46 +0000 (08:30 -0400)]
lib: add NOTMUCH_STATUS_NO_CONFIG
This will allow client code to provide more meaningful diagnostics. In
particular it will enable "notmuch new" to continue suggsting the user
run "notmuch setup" to create a config after "notmuch new" is
transitioned to the new configuration framework.
David Bremner [Fri, 1 Jan 2021 16:16:25 +0000 (12:16 -0400)]
lib/open: factor out choosing database path
The plan is to share code with a new database creation function that
has a similar API to n_d_open_with_config.
David Bremner [Fri, 1 Jan 2021 13:01:24 +0000 (09:01 -0400)]
lib/config: add NOTMUCH_CONFIG_NEW_IGNORE
This will be needed by (at least) the conversion of notmuch-new.c to
the new config framework
David Bremner [Sun, 3 Jan 2021 01:50:24 +0000 (21:50 -0400)]
bindings/notmuch2: add missing crypto error status codes
These are needed so that the later codes line up numerically.
David Bremner [Thu, 24 Dec 2020 03:45:23 +0000 (23:45 -0400)]
cli/compact: convert to new configuration framework
Switch to the newly created API function notmuch_database_compact_db,
which takes the database opened in main().
David Bremner [Thu, 24 Dec 2020 03:37:41 +0000 (23:37 -0400)]
lib: split notmuch_database_compact
The "back end" function takes an open notmuch database, which should
know its own path (i.e. the path needs to be cached in the
configuration data).
David Bremner [Thu, 24 Dec 2020 03:35:42 +0000 (23:35 -0400)]
lib/config: add _notmuch_config_cache
This is a simple convenience routine to cache a configuration value
without writing it to the database.
David Bremner [Mon, 7 Dec 2020 23:48:48 +0000 (19:48 -0400)]
cli/tag: convert to new config framework.
In addition to changing configuration access, change talloc context
for allocation.
David Bremner [Sat, 8 Aug 2020 14:16:53 +0000 (11:16 -0300)]
CLI/show: mostly switch show to new config framework
This will need some cleanup when the transition completes, and we stop
passing notmuch_config_t structs to the subcommands.
Unlike the general case, we open the database in the subcommand, since
we don't know whether it should be opened read/write until we parse
the command line arguments.
Add a test to make sure passing config file on the command line is not
broken by these or future config related changes.
David Bremner [Sat, 8 Aug 2020 14:16:51 +0000 (11:16 -0300)]
cli/config: add accessor for config file name
This is intended for use in temporary code transitioning to the new
configuration system. The name is chosen to avoid cluttering the
notmuch_config_* namespace further with non-library functions.
David Bremner [Sat, 8 Aug 2020 14:16:52 +0000 (11:16 -0300)]
CLI/{search,address}: convert to new configuration framework
Since we are already passing a search context around as a kind of
parameter block, add a new talloc context to that to replace relying
on 'config'.
Convert notmuch-search and notmuch-address at the same time, because
they share some code.
Add a test to make sure we don't break passing configuration as a
command line argument.
David Bremner [Sun, 8 Nov 2020 01:58:32 +0000 (21:58 -0400)]
CLI/reply: convert to new config framework
This is messier than some of the other conversions because the
extensive use of 'config' as a talloc context.
David Bremner [Mon, 5 Oct 2020 23:35:26 +0000 (20:35 -0300)]
cli/reindex: convert new config framework
The only non-trivial part is switching the talloc context for
query_string_from args from 'config' to 'notmuch'.
David Bremner [Wed, 26 Aug 2020 11:43:33 +0000 (08:43 -0300)]
CLI/insert: convert to new config framework.
The new talloc context is needed to run the hook at the very end of
the function. That in turn is needed so that this process gives up the
write lock on the database.
David Bremner [Mon, 5 Oct 2020 23:28:29 +0000 (20:28 -0300)]
CLI/restore: convert to new config framework
Switch one configuration check to new n_c_get_bool function, and
switch use of config as talloc context to notmuch.
David Bremner [Wed, 26 Aug 2020 11:41:48 +0000 (08:41 -0300)]
lib: add notmuch_config_get_bool
Booleans have no out of band values, so return a status for errors.
David Bremner [Wed, 26 Aug 2020 10:54:10 +0000 (07:54 -0300)]
cli/dump: convert to new config framework
This conversion is trivial because the only configuration information
accessed by dump is that stored in the database (in order to dump
it). We do need to be careful to keep the write lock on the database
to ensure dump consistency.
David Bremner [Tue, 22 Dec 2020 12:13:51 +0000 (08:13 -0400)]
CLI/count: switch to new configuration framework
The main effort is changing from the old argv style config list
iterators to the new more opaque ones provided by the library (and
backed by the database+file config cache).
David Bremner [Fri, 1 Jan 2021 13:28:24 +0000 (09:28 -0400)]
lib/config: make values iterators restartable
This is relatively cheap, and makes it easier to transform existing
code which uses arrays of pointers to store configuration lists.
David Bremner [Sat, 8 Aug 2020 14:16:49 +0000 (11:16 -0300)]
lib/config: add config values iterator
This is intended to avoid duplicating the string splitting and
traversal code for all clients of the config API.
David Bremner [Sat, 8 Aug 2020 14:16:48 +0000 (11:16 -0300)]
util: add strsplit_len: simplified strtok with delimiter escaping
This will be used to make iterators for configuration values.
David Bremner [Mon, 21 Dec 2020 12:55:14 +0000 (08:55 -0400)]
CLI: add (unused) database argument to subcommands.
This will allow transitioning individual subcommands to the new
configuration framework. Eventually when they are all converted we can
remove the notmuch_config_t * argument.
For now, live with the parameter shadowing in some some subcommands;
it will go away when they are converted.
David Bremner [Thu, 24 Dec 2020 20:10:05 +0000 (16:10 -0400)]
lib/open: load default values for known configuration keys.
This emulates the behaviour of notmuch_config_open defined in the CLI,
in that it fills in default values if they are not otherwise defined.
David Bremner [Wed, 26 Aug 2020 01:36:43 +0000 (22:36 -0300)]
lib/config: add notmuch_config_key_{get,set}
By using an enum we can have better error detection than copy pasting
key strings around.
The question of what layer this belongs in is a bit
tricky. Historically most of the keys are defined by the CLI. On the
other hand features like excludes are supported in the
library/bindings, and it makes sense to configure them from the
library as well.
The somewhat long prefix for notmuch_config_t is to avoid collisions
with the existing usage in notmuch-client.h.
David Bremner [Mon, 21 Dec 2020 16:12:09 +0000 (12:12 -0400)]
CLI: generalize notmuch_config_mode_t
The renaming and extra values will make sense when we start to convert
subcommands to the new configuration framework. It will also avoid
collisions with a new enum for configuration keys to be introduced in
a future commit.
David Bremner [Sat, 8 Aug 2020 14:16:46 +0000 (11:16 -0300)]
lib/open: add support for config profiles and default locations
Fill in the remainder of the documented functionality for
n_d_open_with_config with respect to config file location. Similar
searching default locations of the database file still needs to be
added.
David Bremner [Sat, 8 Aug 2020 14:16:36 +0000 (11:16 -0300)]
lib: add stub for notmuch_database_open_with_config
Initially document the intended API and copy the code from
notmuch_database_open_verbose. Most of the documented functionality is
not there yet.
David Bremner [Sat, 8 Aug 2020 14:16:37 +0000 (11:16 -0300)]
lib: cache configuration information from database
The main goal is to allow configuration information to be temporarily
overridden by a separate config file. That will require further
changes not in this commit.
The performance impact is unclear, and will depend on the balance
between number of queries and number of distinct metadata items read
on the first call to n_d_get_config.
David Bremner [Sun, 20 Dec 2020 21:10:53 +0000 (17:10 -0400)]
lib: add _notmuch_string_map_set
This will be used (and tested) by the configuration caching code to be
added in the next commit.
David Edmondson [Wed, 3 Feb 2021 09:10:20 +0000 (09:10 +0000)]
emacs: When completing tags, offer each tag once
When prompting for one or more tags to add or remove to/from one or
more threads, ensure that the set of tags offered for completion
contains no duplicates.
Some completion packages (e.g. selectrum) will include every member of
the offered list, resulting in the same tag being indicated as a
possibility several times.
Đoàn Trần Công Danh [Sun, 24 Jan 2021 16:07:57 +0000 (23:07 +0700)]
notmuch-show: use correct format specifier for ssize_t
Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
David Bremner [Sun, 17 Jan 2021 12:35:38 +0000 (08:35 -0400)]
test: add (back) upgrade tests
In
ee897cab8b721 the upgrade tests from pre v3 databases were
removed. The reasons for that are still valid, but we should still
test the code paths that do the upgrade, and it is relatively
straightforward to do that for v3 to v3 upgrades.
David Bremner [Sun, 3 Jan 2021 23:35:13 +0000 (19:35 -0400)]
test/T391-python-cffi
Make bindings test verbose. This helps in debugging.
David Bremner [Sun, 3 Jan 2021 23:35:12 +0000 (19:35 -0400)]
test/T750-gzip: don't compress the xapian database
This causes mysterious failures in trying to detect if a database
exists.
Jonas Bernoulli [Sun, 10 Jan 2021 18:47:22 +0000 (19:47 +0100)]
emacs: avoid type errors due to nil as content-type
The output of "notmuch show --format=sexp --format-version=4"
may contain `:content-type' entries with `nil' as the value,
when it fails to detect the correct value. Account for that
in a few places where we would otherwise risk a type error.
Note that `string=' does not choke on `nil' because it uses
the `symbol-name' when encountering a symbol.
Jonas Bernoulli [Sun, 10 Jan 2021 18:47:21 +0000 (19:47 +0100)]
emacs: notmuch-show--get-cid-content: cosmetics
Jonas Bernoulli [Sun, 10 Jan 2021 18:47:20 +0000 (19:47 +0100)]
emacs: notmuch-show--register-cids: fix names of bindings
Jonas Bernoulli [Sun, 10 Jan 2021 18:47:19 +0000 (19:47 +0100)]
emacs: notmuch-mua-add-more-hidden-headers: use local binding
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:12 +0000 (15:01 +0100)]
emacs: notmuch-address-expand-name: use the actual initial-input
Users may type some text into the buffer on an address line, before
actually invoking address completion. We now use that text as the
initial input when we begin address completion.
Previously we did knowingly replace the actual initial input with some
completion candidate that happens to match. Which candidate is used is
essentially random, at least when the actual initial input is short.
As a result users very often had to begin completion by deleting the
less than helpful "initial input".
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:11 +0000 (15:01 +0100)]
emacs: allow opting out of notmuch's address completion
IMO Notmuch should not override the default completion mechanism by
default, at least not globally. But since users are already used to
this behavior it is probably too late to change it. Do the next best
thing and at least allow users to opt out.
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:10 +0000 (15:01 +0100)]
emacs: notmuch-tree-get-match: No longer define as command
When called from code, then this function returns non-nil when the
message at point is a matched message. However it does nothing at all
to present that information to the user when it called interactively.
It is therefore safe to conclude that nobody is using this as a
command.
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:09 +0000 (15:01 +0100)]
emacs: use string-empty-p
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:08 +0000 (15:01 +0100)]
emacs: make subr-x available in all libraries
Like `cl-lib' and `pcase', which are already available in all
libraries, `subr-x' also provided many useful functions that
we would like to use.
Making `subr-x' available in every library from the get-go means
that we can use the functions it defines without having to double
check every single time, whether the feature is already available
in the current library.
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:07 +0000 (15:01 +0100)]
emacs: improve how cl-lib and pcase are required
We need to load `cl-lib' at run-time because we use more from it than
just macros. Never-the-less many, but not all libraries required it
only at compile-time, which we got away with because at least some
libraries already required it at run-time as well.
We use `cl-lib' and (currently to a lesser extend) `pcase' throughout
the code-base, which means that we should require these features in
most libraries.
In the past we tried to only require these features in just the
libraries that actually need them, without fully succeeding. We did
not succeed in doing so because that means we would have to check
every time that we use a function from these features whether they
are already being required in the current library.
An alternative would be to add the `require' forms at the top of every
library but that is a bit annoying too.
In order to make sure that these features are loaded when needed but
also to keep the noise down we only require them in "notmuch-lib.el",
which most other libraries require, and in most of the few libraries
that do not do so, namely "notmuch-draft.el", "notmuch-message.el" and
"notmuch-parser.el". ("coolj.el", "make-deps.el", various generated
libraries, and "notmuch-compat.el" are left touched.)
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:06 +0000 (15:01 +0100)]
emacs: avoid unnecessary let-bindings
To some extend this is a personal preference, but the preference is
strongly dependent on whether one is used to a language that makes it
necessary to use variables like this.
This makes it perfectly clear that we are first getting and then using
a "foo":
(use-foo (get-foo))
Sure this has to be read "inside out", but that's something one better
gets used to quickly when dealing with lisp. I don't understand why
one would want to write this instead:
(let ((the-foo (get-foo)))
(use-foo the-foo))
Both `get-foo' and `use-foo' are named in a way that make it very
clear that we are dealing with a "foo". Storing the value in an
additional variable `the-foo' does not make this any more clear.
On the contrary I makes the reader wonder why the author choose to
use a variable. Is the value used more than once? Is the value
being retrieved in one context and then used in another (e.g. when
the current buffer changes)?
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:05 +0000 (15:01 +0100)]
emacs: reorder notmuch.el a bit
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:04 +0000 (15:01 +0100)]
emacs: notmuch-search-stash-thread-id: use notmuch-search-query-string
No longer use the function `notmuch-search-get-query', which does
nothing but return the value of that variable. That function was
added in [1:
f47eeac0] for use in `notmuch-read-query' along-side
related `notmuch-show-get-query' and `notmuch-tree-get-query' but
using it here makes little sense.
1:
f47eeac0b0186c3559eb559c4f0bee0e1fac1961
emacs: set default in notmuch-read-query
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:03 +0000 (15:01 +0100)]
emacs: define a few variables as automatically buffer-local
Define these variables as automatically buffer-local, meaning that
they always become buffer-local when set unless explicitly told
otherwise using `setq-default' or when using the Custom interface.
Previously they were declared, which keeps the byte-compiler quiet but
is not actually the same as being defined. `notmuch-search-mode' then
made them buffer-local in the current buffer and then set the local
values. This works but is not kosher.
The definitions of the three non-option variables have to be moved up
a bit to enable the change in the next commit, which see.
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:02 +0000 (15:01 +0100)]
emacs: remove variable notmuch-search-disjunctive-regexp
The value is the only possible value, it is only used in one
place, and using a global variable serves no purpose but to
make things more complicated.
Jonas Bernoulli [Sun, 10 Jan 2021 14:01:01 +0000 (15:01 +0100)]
emacs: various doc-string improvements