( )⚙ D4264 zsh_completion: declare appropriate local parameters for ->string form

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4264

zsh_completion: declare appropriate local parameters for ->string form
ClosedPublic

Authored by av6 on Aug 11 2018, 12:09 AM.

Details

Reviewers
spectral
Group Reviewers
hg-reviewers
Commits
rHG69876534caf2: zsh_completion: declare appropriate local parameters for ->string form
Summary

When ->string form is used for _arguments, the function that calls it must
declare appropriate local parameters.

Managing local return value is needed to tell the completion system if our
function succeeded in suggesting something or not, plus without that `hg diff
-<TAB>` doesn't look right.

While at it, fix a copypaste error (s/diff_files/revert_files/).

Docs: http://zsh.sourceforge.net/Doc/Release/Completion-System.html

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

av6 created this revision.Aug 11 2018, 12:09 AM
spectral accepted this revision.Aug 13 2018, 2:33 PM
spectral added a subscriber: spectral.

I don't understand this aspect super well, I admit I haven't read the docs you linked to, but I can see why this would be more correct :)

Closed by commit rHG69876534caf2: zsh_completion: declare appropriate local parameters for ->string form (authored by av6). · Explain WhyAug 20 2018, 3:19 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mcontrib/zsh_completion (30 lines)

Diff 10330

contrib/zsh_completion

_hg_cmd_copy() { _hg_cmd_copy() {
_arguments -s -S : $_hg_global_opts $_hg_pat_opts $_hg_dryrun_opts \ _arguments -s -S : $_hg_global_opts $_hg_pat_opts $_hg_dryrun_opts \
'(--after -A)'{-A,--after}'[record a copy that has already occurred]' \ '(--after -A)'{-A,--after}'[record a copy that has already occurred]' \
'(--force -f)'{-f,--force}'[forcibly copy over an existing managed file]' \ '(--force -f)'{-f,--force}'[forcibly copy over an existing managed file]' \
'*:file:_hg_files' '*:file:_hg_files'
} }
_hg_cmd_diff() { _hg_cmd_diff() {
local context state state_descr line ret=1
typeset -A opt_args typeset -A opt_args
_arguments -s -S : $_hg_global_opts $_hg_diff_opts $_hg_ignore_space_opts \ _arguments -s -S : $_hg_global_opts $_hg_diff_opts $_hg_ignore_space_opts \
$_hg_pat_opts $_hg_subrepos_opts \ $_hg_pat_opts $_hg_subrepos_opts \
'*'{-r+,--rev=}'[revision]:revision:_hg_revrange' \ '*'{-r+,--rev=}'[revision]:revision:_hg_revrange' \
'(--show-function -p)'{-p,--show-function}'[show which function each change is in]' \ '(--show-function -p)'{-p,--show-function}'[show which function each change is in]' \
'(--change -c)'{-c+,--change=}'[change made by revision]:' \ '(--change -c)'{-c+,--change=}'[change made by revision]:' \
'(--text -a)'{-a,--text}'[treat all files as text]' \ '(--text -a)'{-a,--text}'[treat all files as text]' \
'--reverse[produce a diff that undoes the changes]' \ '--reverse[produce a diff that undoes the changes]' \
'(--unified -U)'{-U+,--unified=}'[number of lines of context to show]:' \ '(--unified -U)'{-U+,--unified=}'[number of lines of context to show]:' \
'--stat[output diffstat-style summary of changes]' \ '--stat[output diffstat-style summary of changes]' \
'*:file:->diff_files' '*:file:->diff_files' && ret=0
if [[ $state == 'diff_files' ]] if [[ $state == 'diff_files' ]]
then then
if [[ -n $opt_args[-r] ]] if [[ -n $opt_args[-r] ]]
then then
_hg_files _hg_files && ret=0
else else
_hg_committable _hg_committable && ret=0
fi fi
fi fi
return ret
} }
_hg_cmd_export() { _hg_cmd_export() {
_arguments -s -S : $_hg_global_opts $_hg_diff_opts \ _arguments -s -S : $_hg_global_opts $_hg_diff_opts \
'(--outout -o)'{-o+,--output=}'[print output to file with formatted name]:filespec:' \ '(--outout -o)'{-o+,--output=}'[print output to file with formatted name]:filespec:' \
'--switch-parent[diff against the second parent]' \ '--switch-parent[diff against the second parent]' \
'(--rev -r)'{-r+,--rev=}'[revision]:revision:_hg_labels' \ '(--rev -r)'{-r+,--rev=}'[revision]:revision:_hg_labels' \
'*:revision:_hg_labels' '*:revision:_hg_labels'
_hg_cmd_rename() { _hg_cmd_rename() {
_arguments -s -S : $_hg_global_opts $_hg_pat_opts $_hg_dryrun_opts \ _arguments -s -S : $_hg_global_opts $_hg_pat_opts $_hg_dryrun_opts \
'(--after -A)'{-A,--after}'[record a rename that has already occurred]' \ '(--after -A)'{-A,--after}'[record a rename that has already occurred]' \
'(--force -f)'{-f,--force}'[forcibly copy over an existing managed file]' \ '(--force -f)'{-f,--force}'[forcibly copy over an existing managed file]' \
'*:file:_hg_files' '*:file:_hg_files'
} }
_hg_cmd_resolve() { _hg_cmd_resolve() {
local context state line local context state state_descr line ret=1
typeset -A opt_args typeset -A opt_args
_arguments -s -S : $_hg_global_opts $_hg_mergetool_opts $_hg_pat_opts \ _arguments -s -S : $_hg_global_opts $_hg_mergetool_opts $_hg_pat_opts \
'(--all -a)'{-a,--all}'[select all unresolved files]' \ '(--all -a)'{-a,--all}'[select all unresolved files]' \
'(--no-status -n)'{-n,--no-status}'[hide status prefix]' \ '(--no-status -n)'{-n,--no-status}'[hide status prefix]' \
'(--list -l --mark -m --unmark -u)'{-l,--list}'[list state of files needing merge]:*:merged files:->resolve_files' \ '(--list -l --mark -m --unmark -u)'{-l,--list}'[list state of files needing merge]:*:merged files:->resolve_files' \
'(--mark -m --list -l --unmark -u)'{-m,--mark}'[mark files as resolved]:*:unresolved files:_hg_unresolved' \ '(--mark -m --list -l --unmark -u)'{-m,--mark}'[mark files as resolved]:*:unresolved files:_hg_unresolved' \
'(--unmark -u --list -l --mark -m)'{-u,--unmark}'[unmark files as resolved]:*:resolved files:_hg_resolved' \ '(--unmark -u --list -l --mark -m)'{-u,--unmark}'[unmark files as resolved]:*:resolved files:_hg_resolved' \
'*:file:_hg_unresolved' '*:file:_hg_unresolved' && ret=0
if [[ $state == 'resolve_files' ]] if [[ $state == 'resolve_files' ]]
then then
_alternative 'files:resolved files:_hg_resolved' \ _alternative 'files:resolved files:_hg_resolved' \
'files:unresolved files:_hg_unresolved' 'files:unresolved files:_hg_unresolved' && ret=0
fi fi
return ret
} }
_hg_cmd_revert() { _hg_cmd_revert() {
local context state line local context state state_descr line ret=1
typeset -A opt_args typeset -A opt_args
_arguments -s -S : $_hg_global_opts $_hg_pat_opts $_hg_dryrun_opts \ _arguments -s -S : $_hg_global_opts $_hg_pat_opts $_hg_dryrun_opts \
'(--all -a :)'{-a,--all}'[revert all changes when no arguments given]' \ '(--all -a :)'{-a,--all}'[revert all changes when no arguments given]' \
'(--rev -r)'{-r+,--rev=}'[revision to revert to]:revision:_hg_labels' \ '(--rev -r)'{-r+,--rev=}'[revision to revert to]:revision:_hg_labels' \
'(--no-backup -C)'{-C,--no-backup}'[do not save backup copies of files]' \ '(--no-backup -C)'{-C,--no-backup}'[do not save backup copies of files]' \
'(--date -d)'{-d+,--date=}'[tipmost revision matching date]:date code:' \ '(--date -d)'{-d+,--date=}'[tipmost revision matching date]:date code:' \
'*:file:->diff_files' '*:file:->revert_files' && ret=0
if [[ $state == 'diff_files' ]] if [[ $state == 'revert_files' ]]
then then
if [[ -n $opt_args[-r] ]] if [[ -n $opt_args[-r] ]]
then then
_hg_files _hg_files && ret=0
else else
typeset -a status_files typeset -a status_files
_hg_status mard _hg_status mard
_wanted files expl 'modified, added, removed or deleted file' _multi_parts / status_files _wanted files expl 'modified, added, removed or deleted file' _multi_parts / status_files && ret=0
fi fi
fi fi
return ret
} }
_hg_cmd_rollback() { _hg_cmd_rollback() {
_arguments -s -S : $_hg_global_opts $_hg_dryrun_opts \ _arguments -s -S : $_hg_global_opts $_hg_dryrun_opts \
'(--force -f)'{-f,--force}'[ignore safety measures]' \ '(--force -f)'{-f,--force}'[ignore safety measures]' \
} }
_hg_cmd_serve() { _hg_cmd_serve() {