taskwarrior/scripts/zsh/_task
2021-01-03 22:58:02 -05:00

292 lines
8.2 KiB
Text

#compdef task
#
# Copyright 2010 - 2021 Johannes Schlatow
# Copyright 2009 P.C. Shyamshankar
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# https://www.opensource.org/licenses/mit-license.php
# filter completion
(( $+functions[_task_filter] )) ||
_task_filter() {
local -a reply
local word=$'[^\0]#\0'
# projects
local _task_projects=($(task _projects))
local task_projects=(
/"$word"/
":values:task projects:compadd -a _task_projects"
)
_regex_words values 'task dates' \
'tod*ay:Today' \
'yes*terday:Yesterday' \
'tom*orrow:Tomorrow' \
'sow:Start of week' \
'soww:Start of work week' \
'socw:Start of calendar week' \
'som:Start of month' \
'soq:Start of quarter' \
'soy:Start of year' \
'eow:End of week' \
'eoww:End of work week' \
'eocw:End of calendar week' \
'eom:End of month' \
'eoq:End of quarter' \
'eoy:End of year' \
'mon:Monday' \
'tue:Tuesday'\
'wed:Wednesday' \
'thu:Thursday' \
'fri:Friday' \
'sat:Saturday' \
'sun:Sunday' \
'good*friday:Good Friday' \
'easter:Easter' \
'eastermonday:Easter Monday' \
'ascension:Ascension' \
'pentecost:Pentecost' \
'midsommar:Midsommar' \
'midsommarafton:Midsommarafton' \
'later:Later' \
'someday:Some Day'
local _task_dates=("$reply[@]")
_regex_words values 'task reldates' \
'hrs:n hours' \
'day:n days' \
'1st:first' \
'2nd:second' \
'3rd:third' \
'th:4th, 5th, etc.' \
'wks:weeks'
local _task_reldates=("$reply[@]")
local task_dates=(
\( "$_task_dates[@]" \|
\( /$'[0-9][0-9]#'/- \( "$_task_reldates[@]" \) \)
\)
)
# This data is a little bit differnt, it may contain any kind of character so
# we parse it manually and quote using '${(q)_desc}' the descriptions
local -a _task_zshids
local _id desc
task _zshids | while IFS=':' read _id desc; do
_task_zshids+=("$_id:${(qq)desc}")
done
_regex_words values 'task IDs' $_task_zshids
local task_zshids=("$reply[@]")
_regex_words values 'task frequencies' \
'daily:Every day' \
'day:Every day' \
'weekdays:Every day skipping weekend days' \
'weekly:Every week' \
'biweekly:Every two weeks' \
'fortnight:Every two weeks' \
'monthly:Every month' \
'quarterly:Every three months' \
'semiannual:Every six months' \
'annual:Every year' \
'yearly:Every year' \
'biannual:Every two years' \
'biyearly:Every two years'
local _task_freqs=("$reply[@]")
_regex_words values 'task frequencies' \
'd:days' \
'w:weeks' \
'q:quarters' \
'y:years'
local _task_frequencies=("$reply[@]")
local task_freqs=(
\( "$_task_freqs[@]" \|
\( /$'[0-9][0-9]#'/- \( "$_task_frequencies[@]" \) \)
\)
)
# task statuses
local _task_statuses=(
pending
completed
deleted
waiting
)
_regex_words statuses 'task statuses' \
"${_task_statuses}"
local task_statuses=("${reply[@]}")
# attributes
local _task_all_attributes=(
'des*cription:Task description text'
'status:Status of task:$task_statuses'
'pro*ject:Project name:$task_projects'
'du*e:Due date:$task_dates'
're*cur:Recurrence frequency:$task_freqs'
'un*til:Expiration date:$task_dates'
'li*mit:Desired number of rows in report'
'wa*it:Date until task becomes pending:$task_dates'
'ent*ry:Date task was created:$task_dates'
'end:Date task was completed/deleted:$task_dates'
'st*art:Date task was started:$task_dates'
'sc*heduled:Date task is scheduled to start:$task_dates'
'depends:Other tasks that this task depends upon:$task_zshids'
)
## add UDAs as attributes
local uda_name uda_label uda_values
local -a udas_spec
task _udas | while read uda_name; do
uda_label="$(task _get rc.uda."$uda_name".label)"
# TODO: we could have got the values of every uda and try to complete that
# but that can become extremly slow with a lot of udas
#uda_values=(${(@s:,:)"$(task _get rc.uda."$uda_name".values)"})
udas_spec+=("${uda_name}:${(q)uda_label}")
done
_task_all_attributes=("${_task_all_attributes[@]}" "${udas_spec[@]}")
_regex_words -t ':' default 'task attributes' "${_task_all_attributes[@]}"
local task_attributes=("$reply[@]")
local _task_tags=($(task _tags))
local _task_config=($(task _config))
local _task_modifiers=(
'before'
'after'
'none'
'any'
'is'
'isnt'
'has'
'hasnt'
'startswith'
'endswith'
'word'
'noword'
)
local _task_conjunctions=(
'and'
'or'
'xor'
'\)'
'\('
'<'
'<='
'='
'!='
'>='
'>'
)
_regex_arguments _task_attributes \
\( "${task_attributes[@]}" \| \
\( /'(project|description|status|entry|end|start|scheduled|depends|due|wait|recur|priority|until|limit).'/- \( /$'[^:]#:'/ ":default:modifiers:compadd -S ':' -a _task_modifiers" \) \) \| \
\( /'(rc).'/- \( /$'[^:]#:'/ ":arguments:config:compadd -S ':' -a _task_config" \) \) \| \
\( /'(+|-)'/- \( /"$word"/ ":values:remove tag:compadd -a _task_tags" \) \) \| \
\( /"$word"/ \) \
\) \#
_task_attributes "$@"
# TODO complete conjunctions only if the previous word is a filter expression, i.e. attribute, ID, any non-command
_describe -t default 'task conjunctions' _task_conjunctions
}
# id-only completion
(( $+functions[_task_ids] )) ||
_task_ids() {
local _ids=( ${(f)"$(task _zshids)"} )
_describe 'task ids' _ids
}
(( $+functions[_task_aliases] )) ||
_task_aliases() {
local _aliases=( ${(f)"$(task _aliases)"} )
_describe 'task aliases' _aliases
}
# subcommand-only function
(( $+functions[_task_subcommands] )) ||
_task_subcommands() {
local -a subcommands
local _zshcmd
local cmd category desc
local lastcategory=''
# The list is sorted by category, in the right order.
local _task_zshcmds=( ${(f)"$(task _zshcommands)"} sentinel:sentinel:sentinel )
for _zshcmd in "$_task_zshcmds[@]"; do
# Parse out the three fields
cmd=${_zshcmd%%:*}
category=${${_zshcmd#*:}%%:*}
desc=${_zshcmd#*:*:}
# Present each category as soon as the first entry in the *next* category
# is seen.
if [[ $category != $lastcategory && -n $lastcategory ]]; then
_describe -t ${lastcategory}-commands "task ${lastcategory} command" subcommands
subcommands=()
fi
# Log the subcommand; we will process it in some future iteration.
subcommands+=( "$cmd:$desc" )
lastcategory=$category
done
}
## contexts
(( $+functions[_task_context] )) ||
_task_context() {
local _contexts=(${(f)"$(task _context)"})
_describe 'task contexts' _contexts
}
## first level completion => task sub-command completion
(( $+functions[_task_default] )) ||
_task_default() {
local cmd ret=1
integer i=1
local _task_cmds=($(task _commands; task _aliases))
while (( i < $#words ))
do
cmd="${_task_cmds[(r)$words[$i]]}"
if (( $#cmd )); then
if (( $+functions[_task_${cmd}] )); then
_task_${cmd}
return ret
fi
_call_function ret _task_filter ||
_message "No command remaining."
return ret
fi
(( i++ ))
done
_task_subcommands
# _task_ids
_task_aliases
_call_function ret _task_filter
return ret
}
_arguments -s -S \
"*::task default:_task_default"