# fish completion for restic -*- shell-script -*- function __restic_debug set -l file "$BASH_COMP_DEBUG_FILE" if test -n "$file" echo "$argv" >> $file end end function __restic_perform_completion __restic_debug "Starting __restic_perform_completion" # Extract all args except the last one set -l args (commandline -opc) # Extract the last arg and escape it in case it is a space set -l lastArg (string escape -- (commandline -ct)) __restic_debug "args: $args" __restic_debug "last arg: $lastArg" # Disable ActiveHelp which is not supported for fish shell set -l requestComp "RESTIC_ACTIVE_HELP=0 $args[1] __complete $args[2..-1] $lastArg" __restic_debug "Calling $requestComp" set -l results (eval $requestComp 2> /dev/null) # Some programs may output extra empty lines after the directive. # Let's ignore them or else it will break completion. # Ref: https://github.com/spf13/cobra/issues/1279 for line in $results[-1..1] if test (string trim -- $line) = "" # Found an empty line, remove it set results $results[1..-2] else # Found non-empty line, we have our proper output break end end set -l comps $results[1..-2] set -l directiveLine $results[-1] # For Fish, when completing a flag with an = (e.g., <program> -n=<TAB>) # completions must be prefixed with the flag set -l flagPrefix (string match -r -- '-.*=' "$lastArg") __restic_debug "Comps: $comps" __restic_debug "DirectiveLine: $directiveLine" __restic_debug "flagPrefix: $flagPrefix" for comp in $comps printf "%s%s\n" "$flagPrefix" "$comp" end printf "%s\n" "$directiveLine" end # this function limits calls to __restic_perform_completion, by caching the result behind $__restic_perform_completion_once_result function __restic_perform_completion_once __restic_debug "Starting __restic_perform_completion_once" if test -n "$__restic_perform_completion_once_result" __restic_debug "Seems like a valid result already exists, skipping __restic_perform_completion" return 0 end set --global __restic_perform_completion_once_result (__restic_perform_completion) if test -z "$__restic_perform_completion_once_result" __restic_debug "No completions, probably due to a failure" return 1 end __restic_debug "Performed completions and set __restic_perform_completion_once_result" return 0 end # this function is used to clear the $__restic_perform_completion_once_result variable after completions are run function __restic_clear_perform_completion_once_result __restic_debug "" __restic_debug "========= clearing previously set __restic_perform_completion_once_result variable ==========" set --erase __restic_perform_completion_once_result __restic_debug "Successfully erased the variable __restic_perform_completion_once_result" end function __restic_requires_order_preservation __restic_debug "" __restic_debug "========= checking if order preservation is required ==========" __restic_perform_completion_once if test -z "$__restic_perform_completion_once_result" __restic_debug "Error determining if order preservation is required" return 1 end set -l directive (string sub --start 2 $__restic_perform_completion_once_result[-1]) __restic_debug "Directive is: $directive" set -l shellCompDirectiveKeepOrder 32 set -l keeporder (math (math --scale 0 $directive / $shellCompDirectiveKeepOrder) % 2) __restic_debug "Keeporder is: $keeporder" if test $keeporder -ne 0 __restic_debug "This does require order preservation" return 0 end __restic_debug "This doesn't require order preservation" return 1 end # This function does two things: # - Obtain the completions and store them in the global __restic_comp_results # - Return false if file completion should be performed function __restic_prepare_completions __restic_debug "" __restic_debug "========= starting completion logic ==========" # Start fresh set --erase __restic_comp_results __restic_perform_completion_once __restic_debug "Completion results: $__restic_perform_completion_once_result" if test -z "$__restic_perform_completion_once_result" __restic_debug "No completion, probably due to a failure" # Might as well do file completion, in case it helps return 1 end set -l directive (string sub --start 2 $__restic_perform_completion_once_result[-1]) set --global __restic_comp_results $__restic_perform_completion_once_result[1..-2] __restic_debug "Completions are: $__restic_comp_results" __restic_debug "Directive is: $directive" set -l shellCompDirectiveError 1 set -l shellCompDirectiveNoSpace 2 set -l shellCompDirectiveNoFileComp 4 set -l shellCompDirectiveFilterFileExt 8 set -l shellCompDirectiveFilterDirs 16 if test -z "$directive" set directive 0 end set -l compErr (math (math --scale 0 $directive / $shellCompDirectiveError) % 2) if test $compErr -eq 1 __restic_debug "Received error directive: aborting." # Might as well do file completion, in case it helps return 1 end set -l filefilter (math (math --scale 0 $directive / $shellCompDirectiveFilterFileExt) % 2) set -l dirfilter (math (math --scale 0 $directive / $shellCompDirectiveFilterDirs) % 2) if test $filefilter -eq 1; or test $dirfilter -eq 1 __restic_debug "File extension filtering or directory filtering not supported" # Do full file completion instead return 1 end set -l nospace (math (math --scale 0 $directive / $shellCompDirectiveNoSpace) % 2) set -l nofiles (math (math --scale 0 $directive / $shellCompDirectiveNoFileComp) % 2) __restic_debug "nospace: $nospace, nofiles: $nofiles" # If we want to prevent a space, or if file completion is NOT disabled, # we need to count the number of valid completions. # To do so, we will filter on prefix as the completions we have received # may not already be filtered so as to allow fish to match on different # criteria than the prefix. if test $nospace -ne 0; or test $nofiles -eq 0 set -l prefix (commandline -t | string escape --style=regex) __restic_debug "prefix: $prefix" set -l completions (string match -r -- "^$prefix.*" $__restic_comp_results) set --global __restic_comp_results $completions __restic_debug "Filtered completions are: $__restic_comp_results" # Important not to quote the variable for count to work set -l numComps (count $__restic_comp_results) __restic_debug "numComps: $numComps" if test $numComps -eq 1; and test $nospace -ne 0 # We must first split on \t to get rid of the descriptions to be # able to check what the actual completion will be. # We don't need descriptions anyway since there is only a single # real completion which the shell will expand immediately. set -l split (string split --max 1 \t $__restic_comp_results[1]) # Fish won't add a space if the completion ends with any # of the following characters: @=/:., set -l lastChar (string sub -s -1 -- $split) if not string match -r -q "[@=/:.,]" -- "$lastChar" # In other cases, to support the "nospace" directive we trick the shell # by outputting an extra, longer completion. __restic_debug "Adding second completion to perform nospace directive" set --global __restic_comp_results $split[1] $split[1]. __restic_debug "Completions are now: $__restic_comp_results" end end if test $numComps -eq 0; and test $nofiles -eq 0 # To be consistent with bash and zsh, we only trigger file # completion when there are no other completions __restic_debug "Requesting file completion" return 1 end end return 0 end # Since Fish completions are only loaded once the user triggers them, we trigger them ourselves # so we can properly delete any completions provided by another script. # Only do this if the program can be found, or else fish may print some errors; besides, # the existing completions will only be loaded if the program can be found. if type -q "restic" # The space after the program name is essential to trigger completion for the program # and not completion of the program name itself. # Also, we use '> /dev/null 2>&1' since '&>' is not supported in older versions of fish. complete --do-complete "restic " > /dev/null 2>&1 end # Remove any pre-existing completions for the program since we will be handling all of them. complete -c restic -e # this will get called after the two calls below and clear the $__restic_perform_completion_once_result global complete -c restic -n '__restic_clear_perform_completion_once_result' # The call to __restic_prepare_completions will setup __restic_comp_results # which provides the program's completion choices. # If this doesn't require order preservation, we don't use the -k flag complete -c restic -n 'not __restic_requires_order_preservation && __restic_prepare_completions' -f -a '$__restic_comp_results' # otherwise we use the -k flag complete -k -c restic -n '__restic_requires_order_preservation && __restic_prepare_completions' -f -a '$__restic_comp_results'