gsh/control_commands_helpers.py

   1 # This program is free software; you can redistribute it and/or modify
   2 # it under the terms of the GNU General Public License as published by
   3 # the Free Software Foundation; either version 2 of the License, or
   4 # (at your option) any later version.
   5 #
   6 # This program is distributed in the hope that it will be useful,
   7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
   8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9 # GNU Library General Public License for more details.
  10 #
  11 # You should have received a copy of the GNU General Public License
  12 # along with this program; if not, write to the Free Software
  13 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  14 #
  15 # See the COPYING file for license information.
  16 #
  17 # Copyright (c) 2006, 2007, 2008 Guillaume Chazarain <guichaz@gmail.com>
  18
  19 import os
  20 from fnmatch import fnmatch
  21 import readline
  22
  23 from gsh.host_syntax import expand_syntax
  24 from gsh.console import console_output
  25 from gsh import dispatchers
  26 from gsh import remote_dispatcher
  27
  28 def toggle_shells(command, enable):
  29     """Enable or disable the specified shells"""
  30     for i in selected_shells(command):
  31         if i.state != remote_dispatcher.STATE_DEAD:
  32             i.set_enabled(enable)
  33
  34 def selected_shells(command):
  35     """Iterator over the shells with names matching the patterns.
  36     An empty patterns matches all the shells"""
  37     selected = set()
  38     instance_found = False
  39     for pattern in (command or '*').split():
  40         found = False
  41         for expanded_pattern in expand_syntax(pattern):
  42             for i in dispatchers.all_instances():
  43                 instance_found = True
  44                 if fnmatch(i.display_name, expanded_pattern):
  45                     found = True
  46                     if i not in selected:
  47                         selected.add(i)
  48                         yield i
  49         if instance_found and not found:
  50             console_output('%s not found\n' % pattern)
  51
  52 def complete_shells(line, text, predicate=lambda i: True):
  53     """Return the shell names to include in the completion"""
  54     res = [i.display_name + ' ' for i in dispatchers.all_instances() if \
  55                 i.display_name.startswith(text) and \
  56                 predicate(i) and \
  57                 ' ' + i.display_name + ' ' not in line]
  58     return res
  59
  60 def expand_local_path(path):
  61     return os.path.expanduser(os.path.expandvars(path) or '~')
  62
  63 def list_control_commands():
  64     import gsh.control_commands
  65     return [c[3:] for c in dir(gsh.control_commands) if c.startswith('do_')]
  66
  67 def get_control_command(name):
  68     import gsh.control_commands
  69     func = getattr(gsh.control_commands, 'do_' + name)
  70     return func
  71
  72 def complete_control_command(line, text):
  73     import gsh.control_commands
  74     if readline.get_begidx() == 0:
  75         # Completing control command name
  76         cmds = list_control_commands()
  77         prefix = text[1:]
  78         matches = [':' + cmd + ' ' for cmd in cmds if cmd.startswith(prefix)]
  79     else:
  80         # Completing control command parameters
  81         cmd = line.split()[0][1:]
  82         def_compl = lambda line: []
  83         compl_func = getattr(gsh.control_commands, 'complete_' + cmd, def_compl)
  84         matches = compl_func(line, text)
  85     return matches
  86
  87 def handle_control_command(line):
  88     if not line:
  89         return
  90     cmd_name = line.split()[0]
  91     try:
  92         cmd_func = get_control_command(cmd_name)
  93     except AttributeError:
  94         console_output('Unknown control command: %s\n' % cmd_name)
  95     else:
  96         parameters = line[len(cmd_name) + 1:]
  97         cmd_func(parameters)
  98