Is it possible to configure the way bash completes directory names?

8

1

I'd like to instruct bash to use a special method to perform completion on certain directory names. For example, bash would call a program of mine to perform completion if a path starts with "$$", and perform completion normally otherwise.

Is this at all possible? How would you implement it?

Bounty: I'd really appreciate an answer to that question. The goal is to allow autojump to complete paths for all commands when the user starts them with a certain prefix. So for example when copying a file from a far directory, you could type:

cp $$patern + <Tab>

and autojump would complete

cp /home/user/CompliCatedDireCTOry/long/path/bla/bla

and you would just have to add where you want to put the file. Of course I can use ott's comment to add it to a few specific commands, but if anyone has a better idea, I'd be very grateful.

Peltier

Posted 2011-09-07T11:11:48.913

Reputation: 4 834

If you vote to close my question, please explain why. – Peltier – 2011-09-07T11:44:20.983

See the section "Programmable Completion" in the bash man page. – None – 2011-09-07T11:35:44.807

2"complete" supports "-G pattern" to match your $$ an the beginning and "-F func" to call your own function, but it needs one or more command names to work. – None – 2011-09-07T13:14:50.320

Why not just use an environment variable? For example: cp $prefix/file /path/to/dest/ – Xenoactive – 2011-09-09T19:58:50.387

@Xenoactive: because autojump is fully automated, and works on more than one path. Using manually set environment variables doesn't help. Or maybe you have a powerful idea that I don't understand? – Peltier – 2011-09-10T10:34:19.447

Answers

3

You can do this by overriding the default binding for TAB(^i). First you need to override the TAB binding, then you need to build a function that calls your command, lastly you need to take the output from that command and update the variable that contains the current command line.

This function takes the current command line and changes the last two characters to 'huugs'.

function my_awesome_tab_completion_function () {
  set -- $READLINE_LINE
  command="$1"
  shift
  argument="$*"
  argument_length=$(echo -n $argument | wc -c)
  if echo $argument | grep '^$$' >/dev/null 2>&1; then
    new_argument=$(echo $argument | sed 's/..$/huugs/') # put your autojump here
  else
    new_argument=$(compgen -d $argument)
  fi
  new_argument_length=$(echo -n $new_argument | wc -c)
  READLINE_POINT=$(( $new_argument_length - $argument_length + $READLINE_POINT ))
  READLINE_LINE="$command $new_argument"
}

For your example you'd probably want to change the new_argument line to look like this:

  new_argument=$(autojump $argument)

Now override the ^i binding:

$ bind -x '"\C-i"':'my_awesome_tab_completion_function'

Now test that it works:

$ cd /ro<TAB>
changes my command to:
$ cd /root

so normal completion still works, you can test the $$ part by doing cd $$... etc

If you run into issues turn on verbose mode:

$ set -x

It will print out everything the function is doing.

I tested this on Ubuntu 11 using bash 4.2.8(1)-release (the default).

polynomial

Posted 2011-09-07T11:11:48.913

Reputation: 1 424

It seems to me that this works only on the first parameter of the command, and can also do weird stuff if the tab is used in unexpected ways (for example after a $$$ or after the command name), or am I wrong ? – harrymc – 2011-09-10T22:35:41.143

Well it is passing $* so it will 'work' on more than just the first parameter(I don't know autojump at all so I'm not sure if it can take multiple arguments). You could shift to the end and only send the last to autojump, or use READLINE_POINT to determine where the cursor is among the command arguments and send only that 'word' to autojump too. – polynomial – 2011-09-12T05:47:10.180

Your solution is interesting, but you have to admit that taking over the tab key is a bit extreme. There is no way that you could anticipate all the possible cases. – harrymc – 2011-09-12T06:48:56.380

Thanks for your answer, that's a nice alternative solution, and it does address the "for all commands" part of my question. I agree with harrymc that it's a bit extreme, though... I guess if nobody comes up with a better solution I'll give it a try and see if it is viable. – Peltier – 2011-09-12T19:30:46.360

Ya I agree with harrymc too, but was trying to answer the question as asked. Personally I would just bind this to another control key like ^G or something so I could leave tab alone but still use this functionality. – polynomial – 2011-09-12T23:57:54.233

OTOH, is tab really used for other things than complete on the command line? What do you use it for? – Peltier – 2011-09-13T07:50:07.670

I use tab for completion of hostnames and command arguments in zsh using compctl. I also find myself using it in some complex commands (like maybe using sed to change a TSV to a CSV). – polynomial – 2011-09-15T03:30:14.913

Tab is used for the completion of : path-names, file-names, user-names, host-names and variable-names. – harrymc – 2011-09-15T20:05:36.417

1

The bash completion routine can be programmed as a shell script.

Here is an example of a shell-script that will replace in any parameter $$[Tab] by my replacement string, but only for the specific command mycommand and only if the parameter is exactly "$$" :

_mycomplete()
{
        if [ ${COMP_WORDS[COMP_CWORD]} == \$\$ ]
        then
                COMPREPLY='my replacement string'
        fi
}
complete -o default -o bashdefault -F _mycomplete mycommand

You must source the script to bash via source <file-name> (or the dot command) to start it working, and then :

mycommand $$[Tab] -> mycommand my replacement string
mycommand $$$[Tab] -> mycommand $$$ (beep)
mycommand whatever[Tab] -> (will complete "whatever" in the normal bash manner)

To always have it working for some or all users, include this in one of the bash profile routines.

The problem with the complete command, is that it will work only for one or more names of commands, that are specified as parameters. One could simply give it the list of all the commands that could possibly be used by the users, or in desperate cases expand /bin/* /usr/bin/* ~/bin/*.

Tested on CentOS 5.5.

This simple script is based on the sources I have listed in my other answer - the one which was deleted by the moderator studiohack. If interested, just ask him to undelete it.

harrymc

Posted 2011-09-07T11:11:48.913

Reputation: 306 093

Thanks for your answer. My question wasn't really about that since I new it was possible, but won't complete all commands. However I think that if polynomial's solution doesn't turn out to be acceptable, I'll implement something like that and try to target the most common commands. – Peltier – 2011-09-12T19:34:45.963