mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-21 18:38:08 +01:00
completion: complete bash completion rewrite
Rewrite the bash completion script to actually do something useful. Supported completions: * All the notmuch commands, command line arguments, and values for keyword arguments. * Tags after + and - in 'notmuch tag'. * Config options in 'notmuch config', and some config option values. * Search prefixes in all commands that use search terms. * Tags after tag: prefix in search terms. * User's email addresses after from: and to: in search terms. This is all based on the bash-completion package [1], and will not work without it. [1] http://bash-completion.alioth.debian.org/
This commit is contained in:
Jani Nikula
David Bremner
parent
b714a808a6
commit
2302fd7925
1 changed files with 314 additions and 44 deletions
|
|
@ -1,10 +1,13 @@
|
||||||
# Bash completion for notmuch
|
# bash completion for notmuch -*- shell-script -*-
|
||||||
#
|
#
|
||||||
# Copyright © 2009 Carl Worth
|
# Copyright © 2013 Jani Nikula
|
||||||
|
#
|
||||||
|
# Based on the bash-completion package:
|
||||||
|
# http://bash-completion.alioth.debian.org/
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# it under the terms of the GNU General Public License as published by
|
# it under the terms of the GNU General Public License as published by
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
# the Free Software Foundation, either version 2 of the License, or
|
||||||
# (at your option) any later version.
|
# (at your option) any later version.
|
||||||
#
|
#
|
||||||
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
|
@ -15,57 +18,324 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with this program. If not, see http://www.gnu.org/licenses/ .
|
# along with this program. If not, see http://www.gnu.org/licenses/ .
|
||||||
#
|
#
|
||||||
# Author: Carl Worth <cworth@cworth.org>
|
# Author: Jani Nikula <jani@nikula.org>
|
||||||
#
|
#
|
||||||
# Based on "notmuch help" as follows:
|
|
||||||
#
|
#
|
||||||
# Usage: notmuch <command> [args...]
|
# BUGS:
|
||||||
#
|
#
|
||||||
# Where <command> and [args...] are as follows:
|
# Add space after an --option without parameter (e.g. reply --decrypt)
|
||||||
|
# on completion.
|
||||||
#
|
#
|
||||||
# setup
|
|
||||||
#
|
|
||||||
# new
|
|
||||||
#
|
|
||||||
# search [options] <search-term> [...]
|
|
||||||
#
|
|
||||||
# show <search-terms>
|
|
||||||
#
|
|
||||||
# reply <search-terms>
|
|
||||||
#
|
|
||||||
# tag +<tag>|-<tag> [...] [--] <search-terms> [...]
|
|
||||||
#
|
|
||||||
# dump [<filename>]
|
|
||||||
#
|
|
||||||
# restore <filename>
|
|
||||||
#
|
|
||||||
# help [<command>]
|
|
||||||
|
|
||||||
_notmuch()
|
_notmuch_user_emails()
|
||||||
{
|
{
|
||||||
local current previous commands help_options
|
notmuch config get user.primary_email
|
||||||
|
notmuch config get user.other_email
|
||||||
|
}
|
||||||
|
|
||||||
previous=${COMP_WORDS[COMP_CWORD-1]}
|
_notmuch_search_terms()
|
||||||
current="${COMP_WORDS[COMP_CWORD]}"
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
# handle search prefixes and tags with colons and equal signs
|
||||||
|
_init_completion -n := || return
|
||||||
|
|
||||||
commands="setup new search show reply tag dump restore help"
|
case "${cur}" in
|
||||||
help_options="setup new search show reply tag dump restore search-terms"
|
tag:*)
|
||||||
search_options="--max-threads= --first= --sort="
|
COMPREPLY=( $(compgen -P "tag:" -W "`notmuch search --output=tags \*`" -- ${cur##tag:}) )
|
||||||
|
;;
|
||||||
|
to:*)
|
||||||
|
COMPREPLY=( $(compgen -P "to:" -W "`_notmuch_user_emails`" -- ${cur##to:}) )
|
||||||
|
;;
|
||||||
|
from:*)
|
||||||
|
COMPREPLY=( $(compgen -P "from:" -W "`_notmuch_user_emails`" -- ${cur##from:}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
local search_terms="from: to: subject: attachment: tag: id: thread: folder: date:"
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "${search_terms}" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
# handle search prefixes and tags with colons
|
||||||
|
__ltrim_colon_completions "${cur}"
|
||||||
|
}
|
||||||
|
|
||||||
COMPREPLY=()
|
_notmuch_config()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion || return
|
||||||
|
|
||||||
case $COMP_CWORD in
|
case "${prev}" in
|
||||||
1)
|
config)
|
||||||
COMPREPLY=( $(compgen -W "${commands}" -- ${current}) ) ;;
|
COMPREPLY=( $(compgen -W "get set list" -- ${cur}) )
|
||||||
2)
|
;;
|
||||||
case $previous in
|
get|set)
|
||||||
help)
|
COMPREPLY=( $(compgen -W "`notmuch config list | sed 's/=.*\$//'`" -- ${cur}) )
|
||||||
COMPREPLY=( $(compgen -W "${help_options}" -- ${current}) ) ;;
|
;;
|
||||||
search)
|
# these will also complete on config get, but we don't care
|
||||||
COMPREPLY=( $(compgen -W "${search_options}" -- ${current}) ) ;;
|
database.path)
|
||||||
esac
|
_filedir
|
||||||
;;
|
;;
|
||||||
|
maildir.synchronize_flags)
|
||||||
|
COMPREPLY=( $(compgen -W "true false" -- ${cur}) )
|
||||||
|
;;
|
||||||
esac
|
esac
|
||||||
}
|
}
|
||||||
|
|
||||||
complete -o default -o bashdefault -F _notmuch notmuch
|
_notmuch_count()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion -s || return
|
||||||
|
|
||||||
|
$split &&
|
||||||
|
case "${prev}" in
|
||||||
|
--output)
|
||||||
|
COMPREPLY=( $( compgen -W "messages threads" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--exclude)
|
||||||
|
COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
! $split &&
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--output= --exclude="
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_notmuch_search_terms
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_dump()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion -s || return
|
||||||
|
|
||||||
|
$split &&
|
||||||
|
case "${prev}" in
|
||||||
|
--format)
|
||||||
|
COMPREPLY=( $( compgen -W "sup batch-tag" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--output)
|
||||||
|
_filedir
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
! $split &&
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--format= --output="
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_notmuch_search_terms
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_new()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion || return
|
||||||
|
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--no-hooks"
|
||||||
|
COMPREPLY=( $(compgen -W "${options}" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_reply()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion -s || return
|
||||||
|
|
||||||
|
$split &&
|
||||||
|
case "${prev}" in
|
||||||
|
--format)
|
||||||
|
COMPREPLY=( $( compgen -W "default json sexp headers-only" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--reply-to)
|
||||||
|
COMPREPLY=( $( compgen -W "all sender" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
! $split &&
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--format= --format-version= --reply-to= --decrypt"
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_notmuch_search_terms
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_restore()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion -s || return
|
||||||
|
|
||||||
|
$split &&
|
||||||
|
case "${prev}" in
|
||||||
|
--format)
|
||||||
|
COMPREPLY=( $( compgen -W "sup batch-tag auto" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--input)
|
||||||
|
_filedir
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
! $split &&
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--format= --accumulate --input="
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_search()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion -s || return
|
||||||
|
|
||||||
|
$split &&
|
||||||
|
case "${prev}" in
|
||||||
|
--format)
|
||||||
|
COMPREPLY=( $( compgen -W "json sexp text text0" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--output)
|
||||||
|
COMPREPLY=( $( compgen -W "summary threads messages files tags" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--sort)
|
||||||
|
COMPREPLY=( $( compgen -W "newest-first oldest-first" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--exclude)
|
||||||
|
COMPREPLY=( $( compgen -W "true false flag" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
! $split &&
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--format= --output= --sort= --offset= --limit= --exclude="
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_notmuch_search_terms
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_show()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
_init_completion -s || return
|
||||||
|
|
||||||
|
$split &&
|
||||||
|
case "${prev}" in
|
||||||
|
--entire-thread)
|
||||||
|
COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--format)
|
||||||
|
COMPREPLY=( $( compgen -W "text json sexp mbox raw" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
--exclude|--body)
|
||||||
|
COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) )
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
! $split &&
|
||||||
|
case "${cur}" in
|
||||||
|
-*)
|
||||||
|
local options="--entire-thread= --format= --exclude= --body= --format-version= --part= --verify --decrypt"
|
||||||
|
compopt -o nospace
|
||||||
|
COMPREPLY=( $(compgen -W "$options" -- ${cur}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_notmuch_search_terms
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch_tag()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
# handle tags with colons and equal signs
|
||||||
|
_init_completion -n := || return
|
||||||
|
|
||||||
|
case "${cur}" in
|
||||||
|
+*)
|
||||||
|
COMPREPLY=( $(compgen -P "+" -W "`notmuch search --output=tags \*`" -- ${cur##+}) )
|
||||||
|
;;
|
||||||
|
-*)
|
||||||
|
COMPREPLY=( $(compgen -P "-" -W "`notmuch search --output=tags \*`" -- ${cur##-}) )
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_notmuch_search_terms
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
# handle tags with colons
|
||||||
|
__ltrim_colon_completions "${cur}"
|
||||||
|
}
|
||||||
|
|
||||||
|
_notmuch()
|
||||||
|
{
|
||||||
|
local _notmuch_commands="config count dump help new reply restore search setup show tag"
|
||||||
|
local arg cur prev words cword split
|
||||||
|
_init_completion || return
|
||||||
|
|
||||||
|
COMPREPLY=()
|
||||||
|
|
||||||
|
# subcommand
|
||||||
|
_get_first_arg
|
||||||
|
|
||||||
|
# complete --help option like the subcommand
|
||||||
|
if [ -z "${arg}" -a "${prev}" = "--help" ]; then
|
||||||
|
arg="help"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${arg}" ]; then
|
||||||
|
# top level completion
|
||||||
|
local top_options="--help --version"
|
||||||
|
case "${cur}" in
|
||||||
|
-*) COMPREPLY=( $(compgen -W "${top_options}" -- ${cur}) ) ;;
|
||||||
|
*) COMPREPLY=( $(compgen -W "${_notmuch_commands}" -- ${cur}) ) ;;
|
||||||
|
esac
|
||||||
|
elif [ "${arg}" = "help" ]; then
|
||||||
|
# handle help command specially due to _notmuch_commands usage
|
||||||
|
local help_topics="$_notmuch_commands hooks search-terms"
|
||||||
|
COMPREPLY=( $(compgen -W "${help_topics}" -- ${cur}) )
|
||||||
|
else
|
||||||
|
# complete using _notmuch_subcommand if one exist
|
||||||
|
local completion_func="_notmuch_${arg//-/_}"
|
||||||
|
declare -f $completion_func >/dev/null && $completion_func
|
||||||
|
fi
|
||||||
|
} &&
|
||||||
|
complete -F _notmuch notmuch
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue