YouCompleteMe/python/ycm/completers/cs/cs_completer.py

#!/usr/bin/env python
#
# Copyright (C) 2011, 2012  Chiel ten Brinke <ctenbrinke@gmail.com>
#                           Strahinja Val Markovic <val@markovic.io>
#
# This file is part of YouCompleteMe.
#
# YouCompleteMe is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# YouCompleteMe is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with YouCompleteMe.  If not, see <http://www.gnu.org/licenses/>.

import vim
import os
import glob
from ycm.completers.threaded_completer import ThreadedCompleter
from ycm import vimsupport
import urllib2
import urllib
import urlparse
import json
import subprocess


class CsharpCompleter( ThreadedCompleter ):
  """
  A Completer that uses the Omnisharp server as completion engine.
  """

  def __init__( self ):
    super( CsharpCompleter, self ).__init__()
    self.OmniSharpPort = int( vimsupport.GetVariableValue(
        "g:ycm_csharp_server_port" ) )
    self.OmniSharpHost = 'http://localhost:' + str( self.OmniSharpPort )
    if vimsupport.GetBoolValue( "g:ycm_auto_start_csharp_server" ):
      self._StartServer()

  def OnVimLeave( self ):
    if self._ServerIsRunning():
      self._StopServer()

  def SupportedFiletypes( self ):
    """ Just csharp """
    return [ 'cs' ]

  def ComputeCandidates( self, unused_query, unused_start_column ):
    return [ { 'word': str( completion['CompletionText'] ),
               'menu': str( completion['DisplayText'] ),
               'info': str( completion['Description'] ) }
             for completion in self._GetCompletions() ]

  def DefinedSubcommands( self ):
    return [ 'StartServer',
             'StopServer',
             'RestartServer' ]

  def OnUserCommand( self, arguments ):
    if not arguments:
      self.EchoUserCommandsHelpMessage()
      return

    command = arguments[ 0 ]
    if command == 'StartServer':
      self._StartServer()
    elif command == 'StopServer':
      self._StopServer()
    elif command == 'RestartServer':
      if self._ServerIsRunning():
        self._StopServer()
      self._StartServer()

  def _StartServer( self ):
    """ Start the OmniSharp server """
    if not self._ServerIsRunning():
      solutionfiles, folder = self._FindSolutionFiles()

      if len( solutionfiles ) == 0:
        vimsupport.PostVimMessage(
                'Error starting OmniSharp server: no solutionfile found' )
        return
      elif len( solutionfiles ) == 1:
        solutionfile = solutionfiles[0]
      else:
        choice = vimsupport.PresentDialog(
                "Which solutionfile should be loaded?",
                [ str(i) + " " + s for i, s in enumerate( solutionfiles ) ] )
        if choice == -1:
          vimsupport.PostVimMessage( 'OmniSharp not started' )
          return
        else:
          solutionfile = solutionfiles[ choice ]

      omnisharp = os.path.join( os.path.abspath( os.path.dirname( __file__ ) ),
              'OmniSharpServer/OmniSharp/bin/Debug/OmniSharp.exe' )
      solutionfile = os.path.join ( folder, solutionfile )
      # command has to be provided as one string for some reason
      command = [ omnisharp + ' -p ' + str( self.OmniSharpPort )
              + ' -s ' + solutionfile ]

      with open( os.devnull, "w" ) as fnull:
        subprocess.Popen( command, stdout = fnull, stderr = fnull, shell=True )

  def _StopServer( self ):
    """ Stop the OmniSharp server """
    self._GetResponse( '/stopserver' )

  def _ServerIsRunning( self ):
    """ Check if the OmniSharp server is running """
    return self._GetResponse( '/checkalivestatus', silent=True ) != None

  def _FindSolutionFiles( self ):
    folder = os.path.dirname( vim.current.buffer.name )
    solutionfiles = glob.glob1( folder, '*.sln' )
    while not solutionfiles:
      lastfolder = folder
      folder = os.path.dirname( folder )
      if folder == lastfolder:
        break
      solutionfiles = glob.glob1( folder, '*.sln' )
    return solutionfiles, folder

  def _GetCompletions( self ):
    """ Ask server for completions """
    line, column = vimsupport.CurrentLineAndColumn()

    parameters = {}
    parameters['line'], parameters['column'] = line + 1, column + 1
    parameters['buffer'] = '\n'.join( vim.current.buffer )
    parameters['filename'] = vim.current.buffer.name

    completions = self._GetResponse( '/autocomplete', parameters )
    return completions if completions != None else []

  def _GetResponse( self, endPoint, parameters={}, silent = False ):
    """ Handle communication with server """
    target = urlparse.urljoin( self.OmniSharpHost, endPoint )
    parameters = urllib.urlencode( parameters )
    try:
      response = urllib2.urlopen( target, parameters )
      return json.loads( response.read() )
    except Exception as e:
      if not silent:
        vimsupport.PostVimMessage('OmniSharp : Could not connect to '
                + target + ': ' + str(e))
      return None