ó [³XMc@sdZddlZddlZddlZddlZddlmZmZm Z ddl m Z de j fd„ƒYZ dfd„ƒYZd efd „ƒYZd efd „ƒYZd efd„ƒYZdfd„ƒYZd„Zd„Zd„Zd„Zdddfdddfdddfdddfd d!d"fd#d$d%fd&d'd(fd)d*dfd+d,dfd-d.dfd/d0d(fd1d2dfd3d4dfd5eefd6eefgZied6ed#6Zeed7„Zd8„Zd9„Zed:kr eƒndS(;s- Rebuild the completion functions for the currently active version of Twisted:: $ python zshcomp.py -i This module implements a zsh code generator which generates completion code for commands that use twisted.python.usage. This is the stuff that makes pressing Tab at the command line work. Maintainer: Eric Mangold To build completion functions for your own commands, and not Twisted commands, then just do something like this:: o = mymodule.MyOptions() f = file('_mycommand', 'w') Builder("mycommand", o, f).write() Then all you have to do is place the generated file somewhere in your C{$fpath}, and restart zsh. Note the "site-functions" directory in your C{$fpath} where you may install 3rd-party completion functions (like the one you're building). Call C{siteFunctionsPath} to locate this directory programmatically. SPECIAL CLASS VARIABLES. You may set these on your usage.Options subclass:: zsh_altArgDescr zsh_multiUse zsh_mutuallyExclusive zsh_actions zsh_actionDescr zsh_extras Here is what they mean (with examples):: zsh_altArgDescr = {"foo":"use this description for foo instead"} A dict mapping long option names to alternate descriptions. When this variable is present, the descriptions contained here will override those descriptions provided in the optFlags and optParameters variables. zsh_multiUse = ["foo", "bar"] A sequence containing those long option names which may appear on the command line more than once. By default, options will only be completed one time. zsh_mutuallyExclusive = [("foo", "bar"), ("bar", "baz")] A sequence of sequences, with each sub-sequence containing those long option names that are mutually exclusive. That is, those options that cannot appear on the command line together. zsh_actions = {"foo":'_files -g "*.foo"', "bar":"(one two three)", "colors":"_values -s , 'colors to use' red green blue"} A dict mapping long option names to Zsh "actions". These actions define what will be completed as the argument to the given option. By default, all files/dirs will be completed if no action is given. Callables may instead be given for the values in this dict. The callable should accept no arguments, and return a string that will be used as the zsh "action" in the same way as the literal strings in the examples above. As you can see in the example above. The "foo" option will have files that end in .foo completed when the user presses Tab. The "bar" option will have either of the strings "one", "two", or "three" completed when the user presses Tab. "colors" will allow multiple arguments to be completed, seperated by commas. The possible arguments are red, green, and blue. Examples:: my_command --foo some-file.foo --colors=red,green my_command --colors=green my_command --colors=green,blue Actions may take many forms, and it is beyond the scope of this document to illustrate them all. Please refer to the documention for the Zsh _arguments function. zshcomp is basically a front-end to Zsh's _arguments completion function. That documentation is available on the zsh web site at this URL: U{http://zsh.sunsite.dk/Doc/Release/zsh_19.html#SEC124} zsh_actionDescr = {"logfile":"log file name", "random":"random seed"} A dict mapping long option names to a description for the corresponding zsh "action". These descriptions are show above the generated matches when the user is doing completions for this option. Normally Zsh does not show these descriptions unless you have "verbose" completion turned on. Turn on verbosity with this in your ~/.zshrc:: zstyle ':completion:*' verbose yes zstyle ':completion:*:descriptions' format '%B%d%b' zsh_extras = [":file to read from:action", ":file to write to:action"] A sequence of extra arguments that will be passed verbatim to Zsh's _arguments completion function. The _arguments function does all the hard work of doing command line completions. You can see how zshcomp invokes the _arguments call by looking at the generated completion files that this module creates. *** NOTE *** You will need to use this variable to describe completions for normal command line arguments. That is, those arguments that are not associated with an option. That is, the arguments that are given to the parseArgs method of your usage.Options subclass. In the example above, the 1st non-option argument will be described as "file to read from" and completion options will be generated in accordance with the "action". (See above about zsh "actions") The 2nd non-option argument will be described as "file to write to" and the action will be interpreted likewise. Things you can put here are all documented under the _arguments function here: U{http://zsh.sunsite.dk/Doc/Release/zsh_19.html#SEC124} Zsh Notes: To enable advanced completion add something like this to your ~/.zshrc:: autoload -U compinit compinit For some extra verbosity, and general niceness add these lines too:: zstyle ':completion:*' verbose yes zstyle ':completion:*:descriptions' format '%B%d%b' zstyle ':completion:*:messages' format '%d' zstyle ':completion:*:warnings' format 'No matches for: %d' Have fun! iÿÿÿÿN(treflecttutiltusage(t IServiceMakert MyOptionscBsJeZdZdZdZdddggZddd dggZd „ZRS( s Options for this file ts>Usage: python zshcomp.py [--install | -i] | tinstalltisiOutput files to the "installation" directory (twisted/python/zsh in the currently active Twisted package)t directorytdsOutput files to this directorycCs„|dr#|dr#tjd‚n|d rH|d rHtjd‚n|dr€tjj|dƒ r€tjd|d‚ndS(NRRs5Can't have --install and --directory at the same timesNot enough argumentss%s is not a directory(Rt UsageErrortostpathtisdir(tself((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt postOptionsšs !N( t__name__t __module__t__doc__tlongdesctsynopsistoptFlagstNonet optParametersR(((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRŽs   tBuildercBseZd„Zd„ZRS(cCs||_||_||_dS(s[ @type cmd_name: C{str} @param cmd_name: The name of the command @type options: C{twisted.usage.Options} @param options: The C{twisted.usage.Options} instance defined for this command @type file: C{file} @param file: The C{file} to write the completion function to N(tcmd_nametoptionstfile(RRRR((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt__init__¤s  cCsC|jjd|jfƒt|j|j|jƒ}|jƒdS(sf Write the completion function to the file given to __init__ @return: C{None} s #compdef %s N(RtwriteRtArgumentsGeneratorR(Rtgen((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRµs(RRRR(((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR£s tSubcommandBuildercBs#eZdZdZdZd„ZRS(s¶ Use this builder for commands that have sub-commands. twisted.python.usage has the notion of sub-commands that are defined using an entirely seperate Options class. cCsd|jjd|jfƒ|jjdƒddlm}|j|jƒ}x.|D]&}|jjd|j|jfƒqSW|jjdƒdg|j j _ t |j|j |jƒ}|jƒ|jjd|j fƒ|j|jƒ}x]|D]U}|jj|jd ƒt |j|j ƒ|jƒ}|jƒ|jjd ƒq÷W|jjd ƒd S( sf Write the completion function to the file given to __init__ @return: C{None} s #compdef %s s.local _zsh_subcmds_array _zsh_subcmds_array=( iÿÿÿÿ(tplugins"%s:%s" s) s*::subcmd:->subcmds‰if (( CURRENT == 1 )); then _describe "%s" _zsh_subcmds_array && ret=0 fi (( ret )) || return 0 service="$words[1]" case $service in s) s;; s8*) _message "don't know how to complete $service";; esacN(RRRttwistedR!t getPluginst interfacettapnamet descriptionRt __class__t zsh_extrasRt subcmdLabel(Rt newplugintpluginstpR((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRÈs& $    N(RRRRR$R)R(((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR ¿st MktapBuildercBseZdZeZdZRS(s' Builder for the mktap command s tap to build(RRRRR$R)(((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR-ìst TwistdBuildercBseZdZeZdZRS(s( Builder for the twistd command sservice to run(RRRRR$R)(((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR.ósRcBs˜eZdZd„Zd„Zd„Zd„Zd„Zd„Zd„Z e d„Z d „Z d „Z d „Zd „Zd „Zd„Zd„ZRS(sq Generate a call to the zsh _arguments completion function based on data in a usage.Options subclass c Cso||_||_||_i|_i|_g|_g|_i|_g|_t j }t j }||j d|jƒ||j d|jƒ||j d|jƒ||j d|jƒ||j d|jƒ||j d|jƒg}g}||j d|ƒ||j d|ƒxEt |ƒD]7\}} t| ƒd kr&tjd | ƒ||x7|jD],}|jjt|ƒƒ|jjdƒq WdS(s… Write out the "extras" list. These are just passed verbatim to the _arguments call @return: C{None} s \ N(R9RRtescape(Rts((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRLescCs|jjdƒdS(sj Write the last bit of code that finishes the call to _arguments @return: C{None} s && return 0 N(RR(R((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRNoscsŸ‡fd†}xHtjˆjˆjˆjˆjƒD]"}|ˆjkr4||ƒq4q4Wx>ˆjD]3}x*|D]"}|ˆjkrq||ƒqqqqWqdWdS(sä Ensure that none of the names given in zsh_* variables are typoed @return: C{None} @raise ValueError: Raised if unknown option names have been given in zsh_* variables cstd|ˆjf‚dS(NsQUnknown option name "%s" found while examining zsh_ attributes for the %s command(t ValueErrorR(tname(R(s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyterr}sN(t itertoolstchainR4R5R8R6RCR7(RRXRWtseq((Rs:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyREvs cCsè||jkr |j|}ng}||jkr|tkro|j|ƒ}|dk r||j|ƒq|q|j|ƒn|s‰dSg}xE|D]=}t|ƒdkrÂ|jd|ƒq–|jd|ƒq–Wddj|ƒS(sÙ Generate an "exclusion string" for the given option @type long: C{str} @param long: The long name of the option (i.e. "verbose" instead of "v") @type buildShort: C{bool} @param buildShort: May be True to indicate we're building an excludes string for the short option that correspondes to the given long opt @return: The generated C{str} Rit-s--s(%s)t N(RGR6tFalsetgetShortOptionRtappendR=tjoin(RRSt buildShortt exclusionstshorttstringstoptName((s:/usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt excludeStrŒs"   c Cs)i}x]tj|j|jƒD]C}y)|ddkrM|d||d|jƒD]0}t|ƒdkr/||||<||=q/q/Wx6|jƒD](\}}|jddƒ}||jkr£qpn|j|ƒ}d}||krÑ||}n|j j j } | dkr7|j j||d|gƒ|d|g|j|<|d|g|j|ˆsJ0-ÿ}                   0