compadd option passing (Re: Completion function for bitkeeper?)

[Bart Schaefer <schaefer@brasslantern.com>]

[redirected to zsh-workers]

On Nov 19, 11:23am, Oliver Kiddle wrote:
}
} I agree that it isn't ideal. The best alternative I can think of would
} be to pass compadd options to the various tag handling functions
} instead of the completion functions.

That makes it harder for people writing simple completion functions to
make use of the compadd options, though.  Maybe that never comes up, but
it seems an unnecessary limitation.

I suggest instead that we choose a single option (or other syntactic
marker) that is documented as being passed to completion functions to
delimit the compadd options from the any options of the function itself.
E.g. soemthing like "everything between -o and a bare '-' is a compadd
option":

	completion_func ... -o compadd options here - ...

That specific suggestion probably won't work because a hyphen may appear
as an argument to -S or -P or -r etc., but you get the idea.

Alternately always pass the compadd options in an array parameter, and
use such a "reserved option" of completion_func to specify the name of
that parameter:

	compaddopts=( ... )
	completion_func ... -o compaddopts ...

In either of the above scenarios, completion functions can avoid name
clashes by extracting the -o option with zparseopts and storing the
resuting array in a local before declaring any other locals whose names
might conflict.  The docs could include sample code for this that could
be cut'n'pasted into new completion functions.