zsh-users
 help / color / mirror / Atom feed
* Completion: How to show description for current option?
@ 2021-08-31 11:03 Marlon Richert
  2021-08-31 11:11 ` Roman Perepelitsa
  2021-09-02 20:08 ` Oliver Kiddle
  0 siblings, 2 replies; 8+ messages in thread
From: Marlon Richert @ 2021-08-31 11:03 UTC (permalink / raw)
  To: Zsh Users

If I type

% git switch -c^D

then completion shows only

-c

Instead, I would like it to show all matching completions with descriptions:

--conflict                               change how conflicting hunks
are presented
--create                  -c             create and switch to a new
branch

I want this even when there is only one matching option.

How do I configure this?


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-08-31 11:03 Completion: How to show description for current option? Marlon Richert
@ 2021-08-31 11:11 ` Roman Perepelitsa
  2021-08-31 17:22   ` Bart Schaefer
  2021-09-02 20:08 ` Oliver Kiddle
  1 sibling, 1 reply; 8+ messages in thread
From: Roman Perepelitsa @ 2021-08-31 11:11 UTC (permalink / raw)
  To: Marlon Richert; +Cc: Zsh Users

On Tue, Aug 31, 2021 at 1:05 PM Marlon Richert <marlon.richert@gmail.com> wrote:
>
> If I type
>
> % git switch -c^D
>
> then completion shows only
>
> -c
>
> Instead, I would like it to show all matching completions with descriptions:
>
> --conflict                               change how conflicting hunks
> are presented
> --create                  -c             create and switch to a new
> branch
>
> I want this even when there is only one matching option.
>
> How do I configure this?

There is accept-exact style. You'll also need to arrange for
--conflict to match against -c (this isn't true by default).

Roman.


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-08-31 11:11 ` Roman Perepelitsa
@ 2021-08-31 17:22   ` Bart Schaefer
  2021-08-31 17:39     ` Roman Perepelitsa
  2021-09-01  0:23     ` Bart Schaefer
  0 siblings, 2 replies; 8+ messages in thread
From: Bart Schaefer @ 2021-08-31 17:22 UTC (permalink / raw)
  To: Roman Perepelitsa; +Cc: Marlon Richert, Zsh Users

On Tue, Aug 31, 2021 at 4:11 AM Roman Perepelitsa
<roman.perepelitsa@gmail.com> wrote:
>
> On Tue, Aug 31, 2021 at 1:05 PM Marlon Richert <marlon.richert@gmail.com> wrote:
> >
> > If I type
> >
> > % git switch -c^D
> >
> > [...] I would like it to show all matching completions with descriptions:
>
> There is accept-exact style.

I don't think that applies here.  Even if it did, wouldn't it have the
opposite effect of what he wants?

> You'll also need to arrange for
> --conflict to match against -c (this isn't true by default).

That might be all that's needed; a matcher-list entry that allows '-'
to become '--'.  But I suspect there's something deeper going on in
the _git suite.


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-08-31 17:22   ` Bart Schaefer
@ 2021-08-31 17:39     ` Roman Perepelitsa
  2021-09-01  0:23     ` Bart Schaefer
  1 sibling, 0 replies; 8+ messages in thread
From: Roman Perepelitsa @ 2021-08-31 17:39 UTC (permalink / raw)
  To: Bart Schaefer; +Cc: Marlon Richert, Zsh Users

On Tue, Aug 31, 2021 at 7:22 PM Bart Schaefer <schaefer@brasslantern.com> wrote:
>
> On Tue, Aug 31, 2021 at 4:11 AM Roman Perepelitsa
> <roman.perepelitsa@gmail.com> wrote:
> >
> > There is accept-exact style.
>
> I don't think that applies here.  Even if it did, wouldn't it have the
> opposite effect of what he wants?

I meant that accept-exact needs to be off. Marlon didn't specify what
config he's using, so I mentioned everything I thought of that could
prevent ambiguous matches from being displayed.

Roman.


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-08-31 17:22   ` Bart Schaefer
  2021-08-31 17:39     ` Roman Perepelitsa
@ 2021-09-01  0:23     ` Bart Schaefer
  2021-09-01 11:27       ` Marlon Richert
  1 sibling, 1 reply; 8+ messages in thread
From: Bart Schaefer @ 2021-09-01  0:23 UTC (permalink / raw)
  To: Roman Perepelitsa; +Cc: Marlon Richert, Zsh Users

On Tue, Aug 31, 2021 at 10:22 AM Bart Schaefer
<schaefer@brasslantern.com> wrote:
>
> That might be all that's needed; a matcher-list entry that allows '-'
> to become '--'.  But I suspect there's something deeper going on in
> the _git suite.

Indeed, the _git suite of functions almost always use _alternative,
which calls _describe with a hardcoded matcher which is prefixed to
whatever appears in the matcher_list style.  On line 41 of
_alternative:

_describe -t "${def%%:*}" "$descr" ws -M 'r:|[_-]=* r:|=*' "$subopts[@]"

I believe that makes it impossible to write a matcher-list zstyle that
will swap out "-" with "--" in the context where Marlon wants it.  Can
someone demonstrate a workaround?


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-09-01  0:23     ` Bart Schaefer
@ 2021-09-01 11:27       ` Marlon Richert
  0 siblings, 0 replies; 8+ messages in thread
From: Marlon Richert @ 2021-09-01 11:27 UTC (permalink / raw)
  To: Bart Schaefer; +Cc: Roman Perepelitsa, Zsh Users

On Wed, Sep 1, 2021 at 3:23 AM Bart Schaefer <schaefer@brasslantern.com> wrote:
>
> On Tue, Aug 31, 2021 at 10:22 AM Bart Schaefer
> <schaefer@brasslantern.com> wrote:
> >
> > That might be all that's needed; a matcher-list entry that allows '-'
> > to become '--'.  But I suspect there's something deeper going on in
> > the _git suite.
>
> Indeed, the _git suite of functions almost always use _alternative,
> which calls _describe with a hardcoded matcher which is prefixed to
> whatever appears in the matcher_list style.  On line 41 of
> _alternative:
>
> _describe -t "${def%%:*}" "$descr" ws -M 'r:|[_-]=* r:|=*' "$subopts[@]"
>
> I believe that makes it impossible to write a matcher-list zstyle that
> will swap out "-" with "--" in the context where Marlon wants it.  Can
> someone demonstrate a workaround?

Thank you all, but unfortunately, none of this is addressing the
actual problems I'm trying to solve. Let me try to rephrase:

# Problem number 1
When I type, for example,
    git switch -c^D
then completion shows me only
    -c
instead of
    -c             create and switch to a new
I would like to be able to see the description to check if I'm
actually using the right option.

# Problem number 2
When I type, for example,
    git switch -c^D
then completion shows me only
    -c
_even if_ I have a matcher (of which the details are not important for
this question) that would actually also match --conflict and --create.

The problem is not in the _git completer (I'm just using `git switch
-c` as an example here) nor in my matchers; the problem is in
_arguments. For whatever reason, if there is a single option that
matches exactly, _arguments decides not to print any description for
it _and_ also refuses to complete any other matching options at that
point.

Is there a way around this? Or have I run into an _arguments bug? The
relevant code can be found on lines 489 - 525:

        if [[ -z "$alwopt" || -z "$tried" || "$alwopt" = arg ]] &&
           comparguments -s single; then

          if [[ "$single" = direct ]]; then
            _all_labels options expl option \
        compadd -QS '' - "${PREFIX}${SUFFIX}"
          elif [[ -z "$optarg" && "$single" = next ]]; then
            _all_labels options expl option \
        compadd -Q - "${PREFIX}${SUFFIX}"
          elif [[ "$single" = equal ]]; then
            _all_labels options expl option \
        compadd -QqS= - "${PREFIX}${SUFFIX}"
          else

    tmp1=( "$next[@]" "$direct[@]" "$odirect[@]" "$equal[@]" )

            [[ "$PREFIX" = [-+]* ]] && tmp1=( "${(@M)tmp1:#${PREFIX[1]}*}" )

            [[ "$single" = next ]] &&
                tmp1=( "${(@)tmp1:#[-+]${PREFIX[-1]}((#e)|:*)}" )

    [[ "$PREFIX" != --* ]] && tmp1=( "${(@)tmp1:#--*}" )
    tmp3=( "${(M@)tmp1:#[-+]?[^:]*}" )
    tmp1=( "${(M@)tmp1:#[-+]?(|:*)}" )
    tmp2=( "${PREFIX}${(@M)^${(@)${(@)tmp1%%:*}#[-+]}:#?}" )

            _describe -O option \
                      tmp1 tmp2 -Q -S '' -- \
      tmp3 -Q

            [[ -n "$optarg" && "$single" = next && nm -eq
$compstate[nmatches] ]] &&
                _all_labels options expl option \
            compadd -Q - "${PREFIX}${SUFFIX}"

          fi
          single=yes


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-08-31 11:03 Completion: How to show description for current option? Marlon Richert
  2021-08-31 11:11 ` Roman Perepelitsa
@ 2021-09-02 20:08 ` Oliver Kiddle
  2021-09-02 20:41   ` Bart Schaefer
  1 sibling, 1 reply; 8+ messages in thread
From: Oliver Kiddle @ 2021-09-02 20:08 UTC (permalink / raw)
  To: Marlon Richert; +Cc: Zsh Users

On 31 Aug, Marlon Richert wrote:
> If I type
>
> % git switch -c^D
>
> then completion shows only
> -c

This can be reproduced with just _arguments -s '-c[desc]'

The code relevant to this is this part of _arguments:

    346       if comparguments -O next direct odirect equal; then
    347         opts=yes
    348         _tags options
    349       elif [[ $? -eq 2 ]]; then
    350           compadd -Q - "${PREFIX}${SUFFIX}"
    351           return 0

The comparguments -O has decided that there are no possible completion
matches which is arguably true because -c is already there and, because
we passed -s to _arguments, it is now trying to complete further options
after -c. It looks like there is special handling for this case that has
only considered actual completion because it is doing a plain compadd
without descriptions.

A similar case would be _arguments -s '-c[desc]' -d
and -dc^D
That prints 'no arguments'

A fix would need to be done within the C code for comparguments -O and
it'd probably be hard to do without breaking it more than fixing it.

Oliver


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Completion: How to show description for current option?
  2021-09-02 20:08 ` Oliver Kiddle
@ 2021-09-02 20:41   ` Bart Schaefer
  0 siblings, 0 replies; 8+ messages in thread
From: Bart Schaefer @ 2021-09-02 20:41 UTC (permalink / raw)
  To: Oliver Kiddle; +Cc: Marlon Richert, Zsh Users

On Thu, Sep 2, 2021 at 1:27 PM Oliver Kiddle <opk@zsh.org> wrote:
>
> The comparguments -O has decided that there are no possible completion
> matches which is arguably true because -c is already there and, because
> we passed -s to _arguments, it is now trying to complete further options

To rephrase this in English, one step up the chain, the difficulty is
that we've told _arguments that short options can be stacked, so -c
could just be the first in a string of single letter options all in
the same shell word.


^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2021-09-02 20:42 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-31 11:03 Completion: How to show description for current option? Marlon Richert
2021-08-31 11:11 ` Roman Perepelitsa
2021-08-31 17:22   ` Bart Schaefer
2021-08-31 17:39     ` Roman Perepelitsa
2021-09-01  0:23     ` Bart Schaefer
2021-09-01 11:27       ` Marlon Richert
2021-09-02 20:08 ` Oliver Kiddle
2021-09-02 20:41   ` Bart Schaefer

zsh-users

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.vuxu.org/zsh-users

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 zsh-users zsh-users/ https://inbox.vuxu.org/zsh-users \
		zsh-users@zsh.org
	public-inbox-index zsh-users

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.zsh.users


code repositories for the project(s) associated with this inbox:

	https://git.vuxu.org/mirror/zsh/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git